Repository navigation
workflow updates, keep-docs-updated, and typo-sweep #766
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| on: | ||
| push: | ||
| branches: [main, master] | ||
| pull_request: | ||
| branches: [main, master] | ||
| workflow_dispatch: | ||
|
|
||
| name: document.yaml | ||
|
|
||
| permissions: read-all | ||
|
|
||
| jobs: | ||
| document: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | ||
| steps: | ||
| - uses: actions/checkout@v6 | ||
|
|
||
| - uses: r-lib/actions/setup-r@v2 | ||
| with: | ||
| use-public-rspm: true | ||
|
|
||
| - name: Get the roxygen2 version from DESCRIPTION | ||
| id: roxygen | ||
| run: | | ||
| version=$(grep '^Config/roxygen2/version:' DESCRIPTION | cut -d ' ' -f 2) | ||
| if [ -z "$version" ]; then | ||
| echo "::error::DESCRIPTION does not contain Config/roxygen2/version." | ||
| exit 1 | ||
| fi | ||
| echo "version=$version" >> "$GITHUB_OUTPUT" | ||
|
|
||
| - uses: r-lib/actions/setup-r-dependencies@v2 | ||
| with: | ||
| extra-packages: roxygen2@${{ steps.roxygen.outputs.version }} | ||
| needs: roxygen2 | ||
|
|
||
| - name: Document | ||
| run: roxygen2::roxygenise() | ||
| shell: Rscript {0} | ||
|
|
||
| - name: Check that man/ and NAMESPACE are up to date | ||
| run: | | ||
| git add --intent-to-add man NAMESPACE | ||
| if ! git diff --exit-code -- man NAMESPACE; then | ||
| echo "::error::The documentation is not up to date. Run devtools::document() and commit the changes." | ||
| exit 1 | ||
| fi |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is our vendored copy, but benign. Already resolved in renv.
https://github.com/rstudio/renv/blob/f3da1726252846650cb926490c06e2a63db64bf4/R/use-python.R#L433