-
-
Notifications
You must be signed in to change notification settings - Fork 17
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into test-rhub-workflows
- Loading branch information
Showing
6 changed files
with
104 additions
and
19 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,11 +16,29 @@ on: | |
| workflow_dispatch: | ||
| workflow_call: | ||
| inputs: | ||
| additional_args: | ||
| lychee-additional-args: | ||
| description: Additional arguments to pass to lychee | ||
| required: false | ||
| type: string | ||
| default: "--exclude-private" | ||
| lychee-fail: | ||
| description: Fail workflow run on error (i.e. when lychee exit code is not 0) | ||
| required: false | ||
| type: boolean | ||
| default: false | ||
| package-subdirectory: | ||
| description: Subdirectory in the repository, where the R package is located. | ||
| required: false | ||
| type: string | ||
| default: "" | ||
| link-checking-method: | ||
| description: | | ||
| Which link checking method should be used? Supported methods are: | ||
| lychee | ||
| urlchecker | ||
| required: false | ||
| type: string | ||
| default: "urlchecker" | ||
|
|
||
| concurrency: | ||
| group: links-${{ github.event.pull_request.number || github.ref }} | ||
|
|
@@ -33,6 +51,7 @@ jobs: | |
| if: > | ||
| !contains(github.event.commits[0].message, '[skip links]') | ||
| && github.event.pull_request.draft == false | ||
| && inputs.link-checking-method == 'lychee' | ||
| steps: | ||
| - name: Get branch names 🌿 | ||
| id: branch-name | ||
|
|
@@ -65,18 +84,69 @@ jobs: | |
| SKIP_INSTRUCTION: "[skip links]" | ||
|
|
||
| - name: Check URLs in docs 🔬 | ||
| uses: lycheeverse/lychee-action@v1.8.0 | ||
| uses: lycheeverse/lychee-action@v1.10.0 | ||
| with: | ||
| args: >- | ||
| --exclude-private | ||
| --exclude "https://github.com.*.git|https://insightsengineering.github.io.*|lewagon.*|knightdave.*|.*users.noreply.github.com|lycheeverse.*" | ||
| --verbose | ||
| --no-progress | ||
| ${{ inputs.additional_args }} | ||
| ${{ inputs.lychee-additional-args }} | ||
| **/*.md | ||
| **/*.html | ||
| **/*.Rmd | ||
| **/*.yaml | ||
| **/*.yml | ||
| *.md | ||
| fail: ${{ inputs.lychee-fail }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| urlchecker: | ||
| name: URL Checker 🔎 | ||
| runs-on: ubuntu-latest | ||
| container: | ||
| image: rocker/tidyverse:latest | ||
| if: > | ||
| !contains(github.event.commits[0].message, '[skip links]') | ||
| && github.event.pull_request.draft == false | ||
| && inputs.link-checking-method == 'urlchecker' | ||
| steps: | ||
| - name: Get branch names 🌿 | ||
| id: branch-name | ||
| uses: tj-actions/branch-names@v7 | ||
|
|
||
| - name: Checkout repo (PR) 🛎 | ||
| uses: actions/[email protected] | ||
| if: github.event_name == 'pull_request' | ||
| with: | ||
| ref: ${{ steps.branch-name.outputs.head_ref_branch }} | ||
| repository: ${{ github.event.pull_request.head.repo.full_name }} | ||
|
|
||
| - name: Checkout repo 🛎 | ||
| uses: actions/[email protected] | ||
| if: github.event_name != 'pull_request' | ||
| with: | ||
| ref: ${{ steps.branch-name.outputs.head_ref_branch }} | ||
|
|
||
| - name: Check commit message 💬 | ||
| run: | | ||
| git config --global --add safe.directory $(pwd) | ||
| export head_commit_message="$(git show -s --format=%B | tr '\r\n' ' ' | tr '\n' ' ')" | ||
| echo "head_commit_message = $head_commit_message" | ||
| if [[ $head_commit_message == *"$SKIP_INSTRUCTION"* ]]; then | ||
| echo "Skip instruction detected - cancelling the workflow." | ||
| exit 1 | ||
| fi | ||
| shell: bash | ||
| env: | ||
| SKIP_INSTRUCTION: "[skip links]" | ||
|
|
||
| - name: Check URLs with urlchecker 🔬 | ||
| run: | | ||
| # For unexplained reasons, parallel = FALSE is required to prevent some false positives. | ||
| bad_urls <- nrow(print(urlchecker::url_check(".", parallel = FALSE))) | ||
| if (bad_urls > 0) { | ||
| stop("Looks like a total of ", bad_urls, " URL(s) were found! Please correct them.") | ||
| } | ||
| shell: Rscript {0} | ||
| working-directory: ${{ inputs.package-subdirectory }} | ||
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| Type: Package | ||
| Package: r.pkg.template | ||
| Title: R Package Template | ||
| Version: 0.1.0.9159 | ||
| Date: 2024-05-14 | ||
| Version: 0.1.0.9167 | ||
| Date: 2024-06-18 | ||
| Authors@R: | ||
| person("insightsengineering", , , "[email protected]", role = c("aut", "cre")) | ||
| Description: R package template with GitHub Actions workflows included. | ||
|
|
||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # r.pkg.template 0.1.0.9159 | ||
| # r.pkg.template 0.1.0.9167 | ||
|
|
||
| ### New features | ||
|
|
||
|
|
||