Closes #2529 documentation add words to desription 2 functions #3909
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| --- | |
| # Source: https://github.com/pharmaverse/admiralci | |
| # Common workflows designed for Admiral | |
| # but can be easily used by any other R package | |
| name: admiral CI/CD Workflows | |
| on: | |
| # 'workflow_dispatch' gives you the ability | |
| # to run this workflow on demand, anytime | |
| workflow_dispatch: | |
| # 'push' events are triggered when commits | |
| # are pushed to one of these branches | |
| push: | |
| tags: | |
| - "v*" | |
| branches: | |
| - main | |
| - patch | |
| # 'pull_request' events are triggered when PRs are | |
| # created against one of these target branches. | |
| pull_request: | |
| branches: | |
| - main | |
| - patch | |
| # 'release' events are triggered when... | |
| # you guessed it - when releases are made. | |
| release: | |
| types: [published] | |
| # Docs on concurrency: | |
| # https://docs.github.com/en/actions/using-jobs/using-concurrency | |
| concurrency: | |
| group: admiral-${{ github.event.pull_request.number || github.ref }} | |
| cancel-in-progress: true | |
| env: | |
| R_VERSION: "release" | |
| jobs: | |
| get_r_version: | |
| name: Get R version | |
| runs-on: ubuntu-latest | |
| outputs: | |
| r-version: ${{ steps.get_r_version.outputs.R_VERSION }} | |
| steps: | |
| - name: Get R Version for Downstream Container Jobs | |
| id: get_r_version | |
| run: echo "R_VERSION=$R_VERSION" >> $GITHUB_OUTPUT | |
| shell: bash | |
| style: | |
| name: Code Style | |
| uses: pharmaverse/admiralci/.github/workflows/style.yml@main | |
| if: github.event_name == 'pull_request' | |
| needs: get_r_version | |
| with: | |
| r-version: "${{ needs.get_r_version.outputs.r-version }}" | |
| spellcheck: | |
| name: Spelling | |
| uses: pharmaverse/admiralci/.github/workflows/spellcheck.yml@main | |
| if: github.event_name == 'pull_request' | |
| needs: get_r_version | |
| with: | |
| r-version: "${{ needs.get_r_version.outputs.r-version }}" | |
| validation: | |
| name: Validation | |
| uses: pharmaverse/admiralci/.github/workflows/r-pkg-validation.yml@main | |
| if: github.event_name == 'release' | |
| needs: get_r_version | |
| with: | |
| r-version: "${{ needs.get_r_version.outputs.r-version }}" | |
| check: | |
| name: Check | |
| uses: pharmaverse/admiralci/.github/workflows/r-cmd-check.yml@main | |
| with: | |
| error-on: warning # TODO: find a way to ignore specific notes | |
| if: github.event_name == 'pull_request' | |
| docs: | |
| name: Documentation | |
| uses: pharmaverse/admiralci/.github/workflows/pkgdown.yml@main | |
| if: github.event_name == 'push' || startsWith(github.ref, 'refs/tags/v') | |
| needs: get_r_version | |
| with: | |
| r-version: "release" | |
| skip-multiversion-docs: true | |
| secrets: | |
| GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} | |
| linter: | |
| name: Lint | |
| uses: pharmaverse/admiralci/.github/workflows/lintr.yml@main | |
| needs: get_r_version | |
| if: github.event_name == 'pull_request' | |
| with: | |
| r-version: "${{ needs.get_r_version.outputs.r-version }}" | |
| links: | |
| name: Links | |
| uses: pharmaverse/admiralci/.github/workflows/links.yml@main | |
| if: github.event_name == 'pull_request' | |
| coverage: | |
| name: Code Coverage | |
| uses: pharmaverse/admiralci/.github/workflows/code-coverage.yml@main | |
| if: > | |
| github.event_name != 'release' | |
| needs: get_r_version | |
| with: | |
| r-version: "${{ needs.get_r_version.outputs.r-version }}" | |
| # Whether to skip code coverage badge creation | |
| # Setting to 'false' will require you to create | |
| # an orphan branch called 'badges' in your repository | |
| skip-coverage-badges: false | |
| man-pages: | |
| name: Man Pages | |
| uses: pharmaverse/admiralci/.github/workflows/man-pages.yml@main | |
| if: github.event_name == 'pull_request' | |
| needs: get_r_version | |
| with: | |
| r-version: "${{ needs.get_r_version.outputs.r-version }}" | |
| templates: | |
| name: Check Templates | |
| uses: pharmaverse/admiralci/.github/workflows/check-templates.yml@main | |
| secrets: inherit | |
| if: github.event_name == 'pull_request' || github.event_name == 'workflow_dispatch' | |
| needs: get_r_version | |
| with: | |
| r-version: "${{ needs.get_r_version.outputs.r-version }}" | |
| vbump: | |
| name: Version Bump 🤜🤛 | |
| if: github.event_name == 'push' | |
| uses: insightsengineering/r.pkg.template/.github/workflows/version-bump.yaml@main | |
| secrets: | |
| REPO_GITHUB_TOKEN: ${{ secrets.PHARMAVERSE_BOT }} |