diff --git a/.github/workflows/check-ci-sync.yml b/.github/workflows/check-ci-sync.yml index eccbc93e..3239d0f6 100644 --- a/.github/workflows/check-ci-sync.yml +++ b/.github/workflows/check-ci-sync.yml @@ -6,7 +6,7 @@ name: Check CI Workflows Sync -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-clang-format.yml b/.github/workflows/check-clang-format.yml index 72300abe..5afd6804 100644 --- a/.github/workflows/check-clang-format.yml +++ b/.github/workflows/check-clang-format.yml @@ -1,6 +1,6 @@ name: Check ClangFormat Configuration -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: @@ -76,7 +76,7 @@ jobs: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable if [[ "${{ github.event.inputs.clang-format-version }}" == "" ]]; then echo "CLANG_FORMAT_VERSION=$(task clang-format:get-version)" >>"$GITHUB_ENV" else @@ -105,7 +105,7 @@ jobs: --file="${{ steps.download-clang-format.outputs.name }}" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.CLANG_FORMAT_INSTALL_PATH }}/clang_Linux_64bit" >>"$GITHUB_PATH" - name: Download yq @@ -125,7 +125,7 @@ jobs: --file="${{ steps.download-yq.outputs.name }}" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.YQ_INSTALL_PATH }}/yq" >>"$GITHUB_PATH" - name: Check ClangFormat configuration file @@ -162,7 +162,7 @@ jobs: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable if [[ "${{ github.event.inputs.clang-format-version }}" == "" ]]; then echo "CLANG_FORMAT_VERSION=$(task clang-format:get-version)" >>"$GITHUB_ENV" else @@ -190,7 +190,7 @@ jobs: --file="${{ steps.download.outputs.name }}" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.CLANG_FORMAT_INSTALL_PATH }}/clang_Linux_64bit" >>"$GITHUB_PATH" - name: Check ClangFormat output @@ -238,7 +238,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "CONVERSION_OUTPUT_PATH=${{ runner.temp }}/clang-format-js-object.txt" >>"$GITHUB_ENV" - name: Checkout repository diff --git a/.github/workflows/check-community-health-sync.yml b/.github/workflows/check-community-health-sync.yml index dd19182e..e13efe97 100644 --- a/.github/workflows/check-community-health-sync.yml +++ b/.github/workflows/check-community-health-sync.yml @@ -6,7 +6,7 @@ name: Check Community Health Files Sync -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-config-sync.yml b/.github/workflows/check-config-sync.yml index a34669fa..0dff2b92 100644 --- a/.github/workflows/check-config-sync.yml +++ b/.github/workflows/check-config-sync.yml @@ -6,7 +6,7 @@ name: Check Configuration Files Sync -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: pull_request: diff --git a/.github/workflows/check-dependabot.yml b/.github/workflows/check-dependabot.yml index 3cdb8dd0..520d68fc 100644 --- a/.github/workflows/check-dependabot.yml +++ b/.github/workflows/check-dependabot.yml @@ -1,6 +1,6 @@ name: Check Dependabot Configuration -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-eslint.yml b/.github/workflows/check-eslint.yml index aa243efe..93cee286 100644 --- a/.github/workflows/check-eslint.yml +++ b/.github/workflows/check-eslint.yml @@ -1,6 +1,6 @@ name: Check ESLint Configuration -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-files-task.yml b/.github/workflows/check-files-task.yml index 40983ac7..ef494ec3 100644 --- a/.github/workflows/check-files-task.yml +++ b/.github/workflows/check-files-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-files-task.md name: Check Files -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-general-formatting-task.yml b/.github/workflows/check-general-formatting-task.yml index 6a38c702..8947f857 100644 --- a/.github/workflows/check-general-formatting-task.yml +++ b/.github/workflows/check-general-formatting-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-general-formatting-task.md name: Check General Formatting -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: @@ -47,7 +47,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >>"$GITHUB_ENV" - name: Checkout repository @@ -82,7 +82,7 @@ jobs: "${{ env.EC_INSTALL_PATH }}/bin/ec" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.EC_INSTALL_PATH }}/bin" >>"$GITHUB_PATH" - name: Check formatting diff --git a/.github/workflows/check-issue-templates.yml b/.github/workflows/check-issue-templates.yml index 20ff16ce..10bf5d2f 100644 --- a/.github/workflows/check-issue-templates.yml +++ b/.github/workflows/check-issue-templates.yml @@ -1,6 +1,6 @@ name: Check Issue Templates -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-javascript-task.yml b/.github/workflows/check-javascript-task.yml index 3880fb96..554bb3b8 100644 --- a/.github/workflows/check-javascript-task.yml +++ b/.github/workflows/check-javascript-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-javascript-task.md name: Check JavaScript -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-labels.yml b/.github/workflows/check-labels.yml index 4e5100f2..83379ae2 100644 --- a/.github/workflows/check-labels.yml +++ b/.github/workflows/check-labels.yml @@ -1,6 +1,6 @@ name: Check Label Configuration -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-license.yml b/.github/workflows/check-license.yml index 809706b2..91babf87 100644 --- a/.github/workflows/check-license.yml +++ b/.github/workflows/check-license.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-license.md name: Check License -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-markdown-task.yml b/.github/workflows/check-markdown-task.yml index 050ef0bc..863ccacb 100644 --- a/.github/workflows/check-markdown-task.yml +++ b/.github/workflows/check-markdown-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md name: Check Markdown -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-markdownlint.yml b/.github/workflows/check-markdownlint.yml index 7819ea45..65efd6f7 100644 --- a/.github/workflows/check-markdownlint.yml +++ b/.github/workflows/check-markdownlint.yml @@ -1,6 +1,6 @@ name: Check markdownlint Configuration -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-npm-task.yml b/.github/workflows/check-npm-task.yml index 30595a1a..bf4a634f 100644 --- a/.github/workflows/check-npm-task.yml +++ b/.github/workflows/check-npm-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-npm-task.md name: Check npm -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-prettier-formatting-task.yml b/.github/workflows/check-prettier-formatting-task.yml index 98ecc5dd..89c017a5 100644 --- a/.github/workflows/check-prettier-formatting-task.yml +++ b/.github/workflows/check-prettier-formatting-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-prettier-formatting-task.md name: Check Prettier Formatting -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-python-task.yml b/.github/workflows/check-python-task.yml index 135384a2..f375d421 100644 --- a/.github/workflows/check-python-task.yml +++ b/.github/workflows/check-python-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-python-task.md name: Check Python -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-shell-task.yml b/.github/workflows/check-shell-task.yml index e32552e4..ea5469ff 100644 --- a/.github/workflows/check-shell-task.yml +++ b/.github/workflows/check-shell-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-shell-task.md name: Check Shell Scripts -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: @@ -81,7 +81,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >>"$GITHUB_ENV" - name: Checkout repository @@ -117,7 +117,7 @@ jobs: )" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >>"$GITHUB_PATH" - name: Run ShellCheck @@ -145,7 +145,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >>"$GITHUB_ENV" - name: Checkout repository @@ -179,7 +179,7 @@ jobs: "${{ env.SHFMT_INSTALL_PATH }}/shfmt" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.SHFMT_INSTALL_PATH }}" >>"$GITHUB_PATH" - name: Format shell scripts diff --git a/.github/workflows/check-taskfiles.yml b/.github/workflows/check-taskfiles.yml index b78a633b..7c42de73 100644 --- a/.github/workflows/check-taskfiles.yml +++ b/.github/workflows/check-taskfiles.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-taskfiles.md name: Check Taskfiles -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-workflows-task.yml b/.github/workflows/check-workflows-task.yml index a8dd76c2..f4011bf6 100644 --- a/.github/workflows/check-workflows-task.yml +++ b/.github/workflows/check-workflows-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-workflows-task.md name: Check Workflows -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-yaml-task.yml b/.github/workflows/check-yaml-task.yml index 00d9fa6f..b58e1dc4 100644 --- a/.github/workflows/check-yaml-task.yml +++ b/.github/workflows/check-yaml-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-yaml-task.md name: Check YAML -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/spell-check-task.yml b/.github/workflows/spell-check-task.yml index acec5f60..ba299efc 100644 --- a/.github/workflows/spell-check-task.yml +++ b/.github/workflows/spell-check-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/spell-check-task.md name: Spell Check -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/sync-labels-npm.yml b/.github/workflows/sync-labels-npm.yml index a8fb8ab8..42dc2ba2 100644 --- a/.github/workflows/sync-labels-npm.yml +++ b/.github/workflows/sync-labels-npm.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels-npm.md name: Sync Labels -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: @@ -99,7 +99,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >>"$GITHUB_ENV" - name: Determine whether to dry run diff --git a/.github/workflows/test-install-script.yml b/.github/workflows/test-install-script.yml index b11c64e6..9fd50588 100644 --- a/.github/workflows/test-install-script.yml +++ b/.github/workflows/test-install-script.yml @@ -13,7 +13,7 @@ on: # Run every day at 03:00 UTC to catch breakage caused by external events - cron: "0 3 * * *" # workflow_dispatch event allows the workflow to be triggered manually. - # See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#workflow_dispatch + # See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows#workflow_dispatch workflow_dispatch: env: @@ -116,7 +116,7 @@ jobs: - name: Set install path environment variable shell: bash run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "BINDIR=${{ runner.temp }}/custom-installation-folder" >>"$GITHUB_ENV" - name: Download script artifact @@ -251,7 +251,7 @@ jobs: - name: Set install path environment variables shell: bash run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable FIRST_INSTALLATION_FOLDER="first-installation-folder" echo "FIRST_INSTALLATION_FOLDER=${FIRST_INSTALLATION_FOLDER}" >>"$GITHUB_ENV" echo "FIRST_BINDIR=${{ runner.temp }}/${FIRST_INSTALLATION_FOLDER}" >>"$GITHUB_ENV" @@ -289,7 +289,7 @@ jobs: - name: Add first installation to PATH shell: bash run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.FIRST_BINDIR }}" >>"$GITHUB_PATH" - name: Check script output with previous installation in PATH (non-Windows) diff --git a/.github/workflows/test-python-poetry-task.yml b/.github/workflows/test-python-poetry-task.yml index 3427989b..5966cfe2 100644 --- a/.github/workflows/test-python-poetry-task.yml +++ b/.github/workflows/test-python-poetry-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/test-python-poetry-task.md name: Test Python -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/issue-templates/template-choosers/github-actions/README.md b/issue-templates/template-choosers/github-actions/README.md index 69e7ab6e..a6e454fb 100644 --- a/issue-templates/template-choosers/github-actions/README.md +++ b/issue-templates/template-choosers/github-actions/README.md @@ -1,6 +1,6 @@ # Issue template chooser configuration for GitHub Actions actions -This is the issue template chooser configuration for use in [GitHub Actions action](https://docs.github.com/actions/creating-actions/about-custom-actions) repositories. +This is the issue template chooser configuration for use in [GitHub Actions action](https://docs.github.com/actions/concepts/workflows-and-actions/custom-actions) repositories. ## Installation diff --git a/workflow-templates/README.md b/workflow-templates/README.md index 76e04954..273d85eb 100644 --- a/workflow-templates/README.md +++ b/workflow-templates/README.md @@ -1,6 +1,6 @@ # GitHub Actions workflow templates -A collection of reusable [GitHub Actions workflows](https://docs.github.com/actions/quickstart#creating-your-first-workflow). +A collection of reusable [GitHub Actions workflows](https://docs.github.com/actions/get-started/quickstart#creating-your-first-workflow). ## Documentation @@ -25,7 +25,7 @@ Addition of, or requests for, any additional workflows that can be reusable betw Dependabot is used to [check for outdated action versions](https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot) used in the template workflows. -Dependabot's PRs will occasionally try to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has [provided a major version ref](https://docs.github.com/actions/creating-actions/about-custom-actions#using-release-management-for-actions), use that instead (e.g., `uses: foo/bar@v2`). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump. +Dependabot's PRs will occasionally try to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has [provided a major version ref](https://docs.github.com/actions/concepts/workflows-and-actions/custom-actions#using-release-management-for-actions), use that instead (e.g., `uses: foo/bar@v2`). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump. --- diff --git a/workflow-templates/assets/dependabot/README.md b/workflow-templates/assets/dependabot/README.md index b8ee877f..19ec9e1b 100644 --- a/workflow-templates/assets/dependabot/README.md +++ b/workflow-templates/assets/dependabot/README.md @@ -10,7 +10,7 @@ Just copy [this `dependabot.yml` file](dependabot.yml) to the `.github/` folder ### Note -Dependabot's PRs will occasionally propose to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has [provided a major version ref](https://docs.github.com/actions/creating-actions/about-custom-actions#using-release-management-for-actions), use that instead (e.g., `uses: foo/bar@v2`). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump. +Dependabot's PRs will occasionally propose to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has [provided a major version ref](https://docs.github.com/actions/concepts/workflows-and-actions/custom-actions#using-release-management-for-actions), use that instead (e.g., `uses: foo/bar@v2`). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump. So even when the PRs from Dependabot are not exactly correct, they still have value in bringing the maintainer's attention to the fact that the action version in use is outdated. The effort needed to manually adjust the ref when this happens is trivial. @@ -37,7 +37,7 @@ https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping ```Markdown Dependabot will periodically check the versions of all actions used in the repository's workflows. If any are found to be outdated, it will submit a pull request to update them. -NOTE: Dependabot's PRs will occasionally propose to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has [provided a major version ref](https://docs.github.com/actions/creating-actions/about-custom-actions#using-release-management-for-actions), use that instead (e.g., `uses: foo/bar@v2`). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump. +NOTE: Dependabot's PRs will occasionally propose to pin to the patch version of the action (e.g., updating `uses: foo/bar@v1` to `uses: foo/bar@v2.3.4`). When the action author has [provided a major version ref](https://docs.github.com/actions/concepts/workflows-and-actions/custom-actions#using-release-management-for-actions), use that instead (e.g., `uses: foo/bar@v2`). Once the major version has been updated in the workflow, Dependabot should not submit an update PR again until the next major version bump. So even when the PRs from Dependabot are not exactly correct, they still have value in bringing the maintainer's attention to the fact that the action version in use is outdated. Dependabot will automatically close its PR once the workflow has been updated. diff --git a/workflow-templates/check-action-metadata-task.md b/workflow-templates/check-action-metadata-task.md index f9b4e0e8..0fb879bf 100644 --- a/workflow-templates/check-action-metadata-task.md +++ b/workflow-templates/check-action-metadata-task.md @@ -86,7 +86,7 @@ triggered periodically, in order to catch breakage caused by external changes. ## PR message ```markdown -A task and GitHub Actions workflow are provided here to check for problems in the [`action.yml`](https://docs.github.com/actions/creating-actions/metadata-syntax-for-github-actions) metadata file of [GitHub Actions actions](https://docs.github.com/actions/learn-github-actions/understanding-github-actions#actions) by validating it against [the JSON schema](https://json.schemastore.org/github-action.json). +A task and GitHub Actions workflow are provided here to check for problems in the [`action.yml`](https://docs.github.com/actions/reference/workflows-and-actions/metadata-syntax) metadata file of [GitHub Actions actions](https://docs.github.com/actions/get-started/understand-github-actions#actions) by validating it against [the JSON schema](https://json.schemastore.org/github-action.json). A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes. ``` diff --git a/workflow-templates/check-action-metadata-task.yml b/workflow-templates/check-action-metadata-task.yml index 9b6e34d5..0060ce8b 100644 --- a/workflow-templates/check-action-metadata-task.yml +++ b/workflow-templates/check-action-metadata-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-action-metadata-task.md name: Check Action Metadata -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-certificates.md b/workflow-templates/check-certificates.md index 809e0a68..26a9645f 100644 --- a/workflow-templates/check-certificates.md +++ b/workflow-templates/check-certificates.md @@ -22,7 +22,7 @@ Replace `TODO_REPO_OWNER/TODO_REPO_NAME` with the repository's name in the `jobs 1. Enter `:warning:` 1. Click the "Save Settings" button 1. Copy the text in the "Webhook URL" field -1. Save the webhook URL to a [repository secret](https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) named `SLACK_WEBHOOK` +1. Save the webhook URL to a [repository secret](https://docs.github.com/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-encrypted-secrets-for-a-repository) named `SLACK_WEBHOOK` - Make sure there is no newline at the end of the secret, otherwise the Slack post process will fail. ### Readme badge diff --git a/workflow-templates/check-certificates.yml b/workflow-templates/check-certificates.yml index 8a47cae3..8a96c4d0 100644 --- a/workflow-templates/check-certificates.yml +++ b/workflow-templates/check-certificates.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-certificates.md name: Check Certificates -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: @@ -82,7 +82,7 @@ jobs: steps: - name: Set certificate path environment variable run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "CERTIFICATE_PATH=${{ runner.temp }}/certificate.p12" >>"$GITHUB_ENV" - name: Decode certificate diff --git a/workflow-templates/check-files-task.yml b/workflow-templates/check-files-task.yml index 40983ac7..ef494ec3 100644 --- a/workflow-templates/check-files-task.yml +++ b/workflow-templates/check-files-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-files-task.md name: Check Files -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-general-formatting-task.yml b/workflow-templates/check-general-formatting-task.yml index 6a38c702..8947f857 100644 --- a/workflow-templates/check-general-formatting-task.yml +++ b/workflow-templates/check-general-formatting-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-general-formatting-task.md name: Check General Formatting -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: @@ -47,7 +47,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >>"$GITHUB_ENV" - name: Checkout repository @@ -82,7 +82,7 @@ jobs: "${{ env.EC_INSTALL_PATH }}/bin/ec" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.EC_INSTALL_PATH }}/bin" >>"$GITHUB_PATH" - name: Check formatting diff --git a/workflow-templates/check-go-dependencies-task.md b/workflow-templates/check-go-dependencies-task.md index 613ca6f9..0f4ff906 100644 --- a/workflow-templates/check-go-dependencies-task.md +++ b/workflow-templates/check-go-dependencies-task.md @@ -53,7 +53,7 @@ Dependency license metadata is stored in the `.licenses` folder. This should be task general:cache-dep-licenses ``` -Alternatively, you can download the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/managing-workflow-runs/downloading-workflow-artifacts) that is generated by the "Check Go Dependencies" workflow run when the cache is found to be outdated by the workflow's "check-cache" job. +Alternatively, you can download the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/how-tos/manage-workflow-runs/download-workflow-artifacts) that is generated by the "Check Go Dependencies" workflow run when the cache is found to be outdated by the workflow's "check-cache" job. #### Unrecognized licenses @@ -106,7 +106,7 @@ The necessary **Licensed** tool can be installed by following [these instruction Unfortunately, **Licensed** does not have Windows support. -An updated cache is also generated whenever the cache is found to be outdated by the "**Check Go Dependencies**" CI workflow and made available for download via the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/managing-workflow-runs/downloading-workflow-artifacts). +An updated cache is also generated whenever the cache is found to be outdated by the "**Check Go Dependencies**" CI workflow and made available for download via the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/how-tos/manage-workflow-runs/download-workflow-artifacts). ```` ## Commit message diff --git a/workflow-templates/check-go-dependencies-task.yml b/workflow-templates/check-go-dependencies-task.yml index dd9e0862..0540f63e 100644 --- a/workflow-templates/check-go-dependencies-task.yml +++ b/workflow-templates/check-go-dependencies-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-dependencies-task.md name: Check Go Dependencies -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-go-task.md b/workflow-templates/check-go-task.md index 9dec0b8a..0735d677 100644 --- a/workflow-templates/check-go-task.md +++ b/workflow-templates/check-go-task.md @@ -19,7 +19,7 @@ Install the [`check-go-task.yml`](check-go-task.yml) GitHub Actions workflow to ### Configuration -If the project contains Go modules in paths other than the root of the repository, add their paths to the [job matrices](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) of `check-go-task.yml` at: +If the project contains Go modules in paths other than the root of the repository, add their paths to the [job matrices](https://docs.github.com/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstrategymatrix) of `check-go-task.yml` at: - `jobs.check-errors.strategy.matrix.module[].path` - `jobs.check-outdated.strategy.matrix.module[].path` diff --git a/workflow-templates/check-go-task.yml b/workflow-templates/check-go-task.yml index 5c807a83..ff6e9597 100644 --- a/workflow-templates/check-go-task.yml +++ b/workflow-templates/check-go-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-go-task.md name: Check Go -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-javascript-task.yml b/workflow-templates/check-javascript-task.yml index 3880fb96..554bb3b8 100644 --- a/workflow-templates/check-javascript-task.yml +++ b/workflow-templates/check-javascript-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-javascript-task.md name: Check JavaScript -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-license.yml b/workflow-templates/check-license.yml index f66f40c7..14c6f33c 100644 --- a/workflow-templates/check-license.yml +++ b/workflow-templates/check-license.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-license.md name: Check License -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-markdown-task.yml b/workflow-templates/check-markdown-task.yml index 050ef0bc..863ccacb 100644 --- a/workflow-templates/check-markdown-task.yml +++ b/workflow-templates/check-markdown-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-markdown-task.md name: Check Markdown -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-mkdocs-task.yml b/workflow-templates/check-mkdocs-task.yml index d99fe144..60d1036e 100644 --- a/workflow-templates/check-mkdocs-task.yml +++ b/workflow-templates/check-mkdocs-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-mkdocs-task.md name: Check Website -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-npm-dependencies-task.md b/workflow-templates/check-npm-dependencies-task.md index c52bd217..0a81bf28 100644 --- a/workflow-templates/check-npm-dependencies-task.md +++ b/workflow-templates/check-npm-dependencies-task.md @@ -59,7 +59,7 @@ Dependency license metadata is stored in the `.licenses` folder. This should be task general:cache-dep-licenses ``` -Alternatively, you can download the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/managing-workflow-runs/downloading-workflow-artifacts) that is generated by the "Check Go Dependencies" workflow run when the cache is found to be outdated by the workflow's "check-cache" job. +Alternatively, you can download the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/how-tos/manage-workflow-runs/download-workflow-artifacts) that is generated by the "Check Go Dependencies" workflow run when the cache is found to be outdated by the workflow's "check-cache" job. ##### Unrecognized licenses @@ -141,7 +141,7 @@ The necessary **Licensed** tool can be installed by following [these instruction Unfortunately, **Licensed** does not have Windows support. -An updated cache is also generated whenever the cache is found to be outdated by the "**Check npm Dependencies**" CI workflow and made available for download via the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/managing-workflow-runs/downloading-workflow-artifacts). +An updated cache is also generated whenever the cache is found to be outdated by the "**Check npm Dependencies**" CI workflow and made available for download via the `dep-licenses-cache` [workflow artifact](https://docs.github.com/actions/how-tos/manage-workflow-runs/download-workflow-artifacts). ```` ## Commit message diff --git a/workflow-templates/check-npm-dependencies-task.yml b/workflow-templates/check-npm-dependencies-task.yml index 393b50d9..f1fa40f0 100644 --- a/workflow-templates/check-npm-dependencies-task.yml +++ b/workflow-templates/check-npm-dependencies-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-npm-dependencies-task.md name: Check npm Dependencies -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-npm-task.md b/workflow-templates/check-npm-task.md index 44d63a8f..27ff1d4b 100644 --- a/workflow-templates/check-npm-task.md +++ b/workflow-templates/check-npm-task.md @@ -35,7 +35,7 @@ If the project contains **npm**-managed projects (i.e., a folder containing a `p #### Workflow -If the project contains **npm**-managed projects (i.e., a folder containing a `package.json` file) in paths other than the root of the repository, add their paths to the [job matrices](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) of `check-npm-task.yml` at: +If the project contains **npm**-managed projects (i.e., a folder containing a `package.json` file) in paths other than the root of the repository, add their paths to the [job matrices](https://docs.github.com/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstrategymatrix) of `check-npm-task.yml` at: - `jobs.validate.strategy.matrix.project[].path` - `jobs.check-sync.strategy.matrix.project[].path` diff --git a/workflow-templates/check-npm-task.yml b/workflow-templates/check-npm-task.yml index 30595a1a..bf4a634f 100644 --- a/workflow-templates/check-npm-task.yml +++ b/workflow-templates/check-npm-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-npm-task.md name: Check npm -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-prettier-formatting-task.yml b/workflow-templates/check-prettier-formatting-task.yml index 98ecc5dd..89c017a5 100644 --- a/workflow-templates/check-prettier-formatting-task.yml +++ b/workflow-templates/check-prettier-formatting-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-prettier-formatting-task.md name: Check Prettier Formatting -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-python-task.yml b/workflow-templates/check-python-task.yml index 135384a2..f375d421 100644 --- a/workflow-templates/check-python-task.yml +++ b/workflow-templates/check-python-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-python-task.md name: Check Python -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-shell-task.md b/workflow-templates/check-shell-task.md index f7d2d1e0..568befb9 100644 --- a/workflow-templates/check-shell-task.md +++ b/workflow-templates/check-shell-task.md @@ -25,7 +25,7 @@ The formatting style defined in `.editorconfig` is the official standardized sty ### Configuration -Configure the paths of the shell scripts to be checked as elements in the [job matrices](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) of `check-shell-task.yml` at: +Configure the paths of the shell scripts to be checked as elements in the [job matrices](https://docs.github.com/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstrategymatrix) of `check-shell-task.yml` at: - `jobs.lint.strategy.matrix.script[]` - `jobs.formatting.strategy.matrix.script[]` diff --git a/workflow-templates/check-shell-task.yml b/workflow-templates/check-shell-task.yml index b2b0521d..29fb5a51 100644 --- a/workflow-templates/check-shell-task.yml +++ b/workflow-templates/check-shell-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-shell-task.md name: Check Shell Scripts -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: @@ -82,7 +82,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >>"$GITHUB_ENV" - name: Checkout repository @@ -118,7 +118,7 @@ jobs: )" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >>"$GITHUB_PATH" - name: Run ShellCheck @@ -147,7 +147,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >>"$GITHUB_ENV" - name: Checkout repository @@ -181,7 +181,7 @@ jobs: "${{ env.SHFMT_INSTALL_PATH }}/shfmt" # Add installation to PATH: - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#adding-a-system-path echo "${{ env.SHFMT_INSTALL_PATH }}" >>"$GITHUB_PATH" - name: Format shell scripts diff --git a/workflow-templates/check-taskfiles.yml b/workflow-templates/check-taskfiles.yml index b78a633b..7c42de73 100644 --- a/workflow-templates/check-taskfiles.yml +++ b/workflow-templates/check-taskfiles.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-taskfiles.md name: Check Taskfiles -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-toc-task.yml b/workflow-templates/check-toc-task.yml index bdf21515..03c193cc 100644 --- a/workflow-templates/check-toc-task.yml +++ b/workflow-templates/check-toc-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-toc-task.md name: Check ToC -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-workflows-task.yml b/workflow-templates/check-workflows-task.yml index f05a5e2e..9eb7faf5 100644 --- a/workflow-templates/check-workflows-task.yml +++ b/workflow-templates/check-workflows-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-workflows-task.md name: Check Workflows -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-yaml-task.yml b/workflow-templates/check-yaml-task.yml index 00d9fa6f..b58e1dc4 100644 --- a/workflow-templates/check-yaml-task.yml +++ b/workflow-templates/check-yaml-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/check-yaml-task.md name: Check YAML -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/deploy-mkdocs-poetry.yml b/workflow-templates/deploy-mkdocs-poetry.yml index 0a42e1b7..3634fac6 100644 --- a/workflow-templates/deploy-mkdocs-poetry.yml +++ b/workflow-templates/deploy-mkdocs-poetry.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/deploy-mkdocs-poetry.md name: Deploy Website -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: branches: diff --git a/workflow-templates/publish-go-nightly-task.md b/workflow-templates/publish-go-nightly-task.md index e111cf2f..237a25c9 100644 --- a/workflow-templates/publish-go-nightly-task.md +++ b/workflow-templates/publish-go-nightly-task.md @@ -18,7 +18,7 @@ See [the "Release" workflow (Go, Task) documentation](release-go-task.md#assets) See [the "Release" workflow (Go, Task) documentation](release-go-task.md#configuration) -In addition, the following [repository secret](https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) must be defined: +In addition, the following [repository secret](https://docs.github.com/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-encrypted-secrets-for-a-repository) must be defined: - `DD_API_KEY` - [Datadog](https://www.datadoghq.com/) API key. diff --git a/workflow-templates/publish-go-nightly-task.yml b/workflow-templates/publish-go-nightly-task.yml index 9a26ac57..a17000c7 100644 --- a/workflow-templates/publish-go-nightly-task.yml +++ b/workflow-templates/publish-go-nightly-task.yml @@ -11,7 +11,7 @@ env: AWS_REGION: "us-east-1" ARTIFACT_PREFIX: dist- -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: schedule: # run every day at 1AM @@ -92,7 +92,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "BUILD_FOLDER=${{ env.PROJECT_NAME }}_osx_${{ matrix.build.folder-suffix }}" >>"$GITHUB_ENV" - name: Checkout repository diff --git a/workflow-templates/publish-go-tester-task.md b/workflow-templates/publish-go-tester-task.md index ca004e1b..7e6008a0 100644 --- a/workflow-templates/publish-go-tester-task.md +++ b/workflow-templates/publish-go-tester-task.md @@ -1,6 +1,6 @@ # "Publish Tester Build" workflow (Go, Task) -Publish tester builds of a [Go](https://golang.org/) project as [GitHub Actions workflow artifacts](https://docs.github.com/actions/using-workflows/storing-workflow-data-as-artifacts) for every commit to a pull request or the repository. +Publish tester builds of a [Go](https://golang.org/) project as [GitHub Actions workflow artifacts](https://docs.github.com/actions/tutorials/store-and-share-data) for every commit to a pull request or the repository. This makes it possible for any interested party to participate in beta testing without setting up a build system locally. @@ -64,7 +64,7 @@ This makes it possible for any interested party to participate in beta testing w On every commit to a pull request or the repository: - Build the project for all supported platforms. -- Upload the builds as [workflow artifacts](https://docs.github.com/actions/using-workflows/storing-workflow-data-as-artifacts). +- Upload the builds as [workflow artifacts](https://docs.github.com/en/actions/tutorials/store-and-share-data). This makes it possible for any interested party to participate in beta testing without setting up a build system locally. ``` diff --git a/workflow-templates/publish-go-tester-task.yml b/workflow-templates/publish-go-tester-task.yml index 6a17c08b..ab77d5c6 100644 --- a/workflow-templates/publish-go-tester-task.yml +++ b/workflow-templates/publish-go-tester-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/publish-go-tester-task.md name: Publish Tester Build -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/release-go-crosscompile-task.md b/workflow-templates/release-go-crosscompile-task.md index 39fa61b6..11320f81 100644 --- a/workflow-templates/release-go-crosscompile-task.md +++ b/workflow-templates/release-go-crosscompile-task.md @@ -42,7 +42,7 @@ We need a special [IAM Role](https://docs.aws.amazon.com/rolesanywhere/latest/us #### Repository secrets -The following [repository secrets](https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) must be defined: +The following [repository secrets](https://docs.github.com/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-encrypted-secrets-for-a-repository) must be defined: - `INSTALLER_CERT_MAC_P12` - the [Apple Developer ID](https://developer.apple.com/support/developer-id/) signing certificate, exported in [PKCS #12 format](https://wikipedia.org/wiki/PKCS_12) and then encoded into base64 as described [here](https://www.kencochrane.com/2020/08/01/build-and-sign-golang-binaries-for-macos-with-github-actions/#exporting-the-developer-certificate). - `INSTALLER_CERT_MAC_PASSWORD` - the password used to encrypt the Apple Developer ID signing certificate during the export process. @@ -51,7 +51,7 @@ The following [repository secrets](https://docs.github.com/actions/security-guid - `AC_PASSWORD` - [App-specific password](https://support.apple.com/en-us/HT204397) created for the Apple ID. - `DOWNLOADS_BUCKET` - [AWS bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html) on the downloads server. -The following [environment secrets](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) must be defined under `production` environment: +The following [environment secrets](https://docs.github.com/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments#environment-secrets) must be defined under `production` environment: - `AWS_ROLE_TO_ASSUME` - [AWS role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) to generate temporary security credentials. diff --git a/workflow-templates/release-go-crosscompile-task.yml b/workflow-templates/release-go-crosscompile-task.yml index 934d2319..f5719338 100644 --- a/workflow-templates/release-go-crosscompile-task.yml +++ b/workflow-templates/release-go-crosscompile-task.yml @@ -104,7 +104,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "BUILD_FOLDER=${{ env.PROJECT_NAME }}_osx_${{ matrix.build.folder-suffix }}" >>"$GITHUB_ENV" TAG="${GITHUB_REF/refs\/tags\//}" diff --git a/workflow-templates/release-go-task.md b/workflow-templates/release-go-task.md index 9b8066e6..9a9c6f85 100644 --- a/workflow-templates/release-go-task.md +++ b/workflow-templates/release-go-task.md @@ -42,7 +42,7 @@ We need a special [IAM Role](https://docs.aws.amazon.com/rolesanywhere/latest/us #### Repository secrets -The following [repository secrets](https://docs.github.com/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) must be defined: +The following [repository secrets](https://docs.github.com/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-encrypted-secrets-for-a-repository) must be defined: - `INSTALLER_CERT_MAC_P12` - the [Apple Developer ID](https://developer.apple.com/support/developer-id/) signing certificate, exported in [PKCS #12 format](https://wikipedia.org/wiki/PKCS_12) and then encoded into base64 as described [here](https://www.kencochrane.com/2020/08/01/build-and-sign-golang-binaries-for-macos-with-github-actions/#exporting-the-developer-certificate). - `INSTALLER_CERT_MAC_PASSWORD` - the password used to encrypt the Apple Developer ID signing certificate during the export process. @@ -51,7 +51,7 @@ The following [repository secrets](https://docs.github.com/actions/security-guid - `AC_PASSWORD` - [App-specific password](https://support.apple.com/en-us/HT204397) created for the Apple ID. - `DOWNLOADS_BUCKET` - [AWS bucket](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingBucket.html) on the downloads server. -The following [environment secrets](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-secrets) must be defined under `production` environment: +The following [environment secrets](https://docs.github.com/actions/how-tos/deploy/configure-and-manage-deployments/manage-environments#environment-secrets) must be defined under `production` environment: - `AWS_ROLE_TO_ASSUME` - [AWS role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html) to generate temporary security credentials. diff --git a/workflow-templates/release-go-task.yml b/workflow-templates/release-go-task.yml index 97ada5cb..12642ddf 100644 --- a/workflow-templates/release-go-task.yml +++ b/workflow-templates/release-go-task.yml @@ -99,7 +99,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "BUILD_FOLDER=${{ env.PROJECT_NAME }}_osx_${{ matrix.build.folder-suffix }}" >>"$GITHUB_ENV" TAG="${GITHUB_REF/refs\/tags\//}" diff --git a/workflow-templates/release-tag.yml b/workflow-templates/release-tag.yml index e2f120ba..a7355aee 100644 --- a/workflow-templates/release-tag.yml +++ b/workflow-templates/release-tag.yml @@ -19,7 +19,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "CHANGELOG_PATH=${{ runner.temp }}/CHANGELOG.md" >>"$GITHUB_ENV" echo "SEMVER_TOOL_PATH=${{ runner.temp }}/semver" >>"$GITHUB_ENV" diff --git a/workflow-templates/spell-check-task.yml b/workflow-templates/spell-check-task.yml index acec5f60..ba299efc 100644 --- a/workflow-templates/spell-check-task.yml +++ b/workflow-templates/spell-check-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/spell-check-task.md name: Spell Check -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/sync-labels-npm.yml b/workflow-templates/sync-labels-npm.yml index a8fb8ab8..42dc2ba2 100644 --- a/workflow-templates/sync-labels-npm.yml +++ b/workflow-templates/sync-labels-npm.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels-npm.md name: Sync Labels -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: @@ -99,7 +99,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >>"$GITHUB_ENV" - name: Determine whether to dry run diff --git a/workflow-templates/sync-labels.yml b/workflow-templates/sync-labels.yml index 7777ebab..05f112cf 100644 --- a/workflow-templates/sync-labels.yml +++ b/workflow-templates/sync-labels.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md name: Sync Labels -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: push: paths: @@ -89,7 +89,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/reference/workflows-and-actions/workflow-commands#setting-an-environment-variable echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >>"$GITHUB_ENV" - name: Determine whether to dry run diff --git a/workflow-templates/test-go-integration-task.yml b/workflow-templates/test-go-integration-task.yml index 3c67e4fc..98377361 100644 --- a/workflow-templates/test-go-integration-task.yml +++ b/workflow-templates/test-go-integration-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/test-go-integration-task.md name: Test Integration -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/test-go-task.md b/workflow-templates/test-go-task.md index 6c03ffe5..d1039f73 100644 --- a/workflow-templates/test-go-task.md +++ b/workflow-templates/test-go-task.md @@ -21,7 +21,7 @@ Install the [`test-go-task.yml`](test-go-task.yml) GitHub Actions workflow to `. #### Workflow -If the project contains Go modules in paths other than the root of the repository, add their paths to the [job matrix](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix) in `check-go-task.yml` at `jobs.test.strategy.matrix.module[].path` and the [Codecov flag](https://docs.codecov.com/docs/flags) to group their data under at `jobs.test.strategy.matrix.module[].codecov-flags` +If the project contains Go modules in paths other than the root of the repository, add their paths to the [job matrix](https://docs.github.com/actions/reference/workflows-and-actions/workflow-syntax#jobsjob_idstrategymatrixx) in `check-go-task.yml` at `jobs.test.strategy.matrix.module[].path` and the [Codecov flag](https://docs.codecov.com/docs/flags) to group their data under at `jobs.test.strategy.matrix.module[].codecov-flags` Replace `TODO_REPO_OWNER/TODO_REPO_NAME` with the repository's name (e.g., `arduino/arduino-cli`) in the `codecov/codecov-action` action's `fail_ci_if_error` input in `test-go-task.yml`. diff --git a/workflow-templates/test-go-task.yml b/workflow-templates/test-go-task.yml index 50b6ff96..2c624547 100644 --- a/workflow-templates/test-go-task.yml +++ b/workflow-templates/test-go-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/test-go-task.md name: Test Go -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/test-python-poetry-task.yml b/workflow-templates/test-python-poetry-task.yml index 3427989b..5966cfe2 100644 --- a/workflow-templates/test-python-poetry-task.yml +++ b/workflow-templates/test-python-poetry-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/test-python-poetry-task.md name: Test Python -# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows +# See: https://docs.github.com/actions/reference/workflows-and-actions/events-that-trigger-workflows on: create: push: