diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index ed4019da..b0e14d19 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -5,10 +5,10 @@ contact_links: url: https://github.com/arduino/tooling-project-assets#readme about: Detailed usage documentation is available here. - name: Learn about GitHub Actions - url: https://docs.github.com/en/actions + url: https://docs.github.com/actions about: Everything you need to know to get started with GitHub Actions. - name: Learn about GitHub issue templates - url: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests + url: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests about: Information about GitHub's issue template feature. - name: Support request url: https://forum.arduino.cc/ diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 51e5643e..fbeabae2 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,10 +1,10 @@ -# See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file +# See: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#about-the-dependabotyml-file version: 2 updates: # Configure check for outdated GitHub Actions actions in workflows. # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/dependabot/README.md - # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot + # See: https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot - package-ecosystem: github-actions directory: / # Check the repository's workflows under /.github/workflows/ schedule: diff --git a/.github/workflows/check-ci-sync.yml b/.github/workflows/check-ci-sync.yml index 4ee45ee3..1ab02c73 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-community-health-sync.yml b/.github/workflows/check-community-health-sync.yml index 2edbdb54..be5230c5 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-config-sync.yml b/.github/workflows/check-config-sync.yml index 1c117b40..408ecdf7 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: pull_request: diff --git a/.github/workflows/check-configs.yml b/.github/workflows/check-configs.yml index edec82da..215de73f 100644 --- a/.github/workflows/check-configs.yml +++ b/.github/workflows/check-configs.yml @@ -1,6 +1,6 @@ name: Check Configuration Files -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-general-formatting-task.yml b/.github/workflows/check-general-formatting-task.yml index e1c202b6..feaceb00 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: pull_request: @@ -18,7 +18,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >> "$GITHUB_ENV" - name: Checkout repository @@ -46,7 +46,7 @@ jobs: # Give the binary a standard name mv "${{ env.EC_INSTALL_PATH }}/bin/ec-linux-amd64" "${{ env.EC_INSTALL_PATH }}/bin/ec" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.EC_INSTALL_PATH }}/bin" >> "$GITHUB_PATH" - name: Check formatting diff --git a/.github/workflows/check-license.yml b/.github/workflows/check-license.yml index 698f6b60..a7cd4172 100644 --- a/.github/workflows/check-license.yml +++ b/.github/workflows/check-license.yml @@ -7,7 +7,7 @@ env: # SPDX identifier: https://spdx.org/licenses/ EXPECTED_LICENSE_TYPE: CC0-1.0 -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-markdown-task.yml b/.github/workflows/check-markdown-task.yml index a308265c..4153c666 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-prettier-formatting-task.yml b/.github/workflows/check-prettier-formatting-task.yml index 68247c87..7e4ac7a3 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/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-python-task.yml b/.github/workflows/check-python-task.yml index 9a09adb1..38553f00 100644 --- a/.github/workflows/check-python-task.yml +++ b/.github/workflows/check-python-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-shell-task.yml b/.github/workflows/check-shell-task.yml index fa305077..90d985ff 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -50,7 +50,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >> "$GITHUB_ENV" - name: Checkout repository @@ -77,7 +77,7 @@ jobs: tar --extract --file="${{ steps.download.outputs.name }}" EXTRACTION_FOLDER="$(basename "${{ steps.download.outputs.name }}" "${{ env.SHELLCHECK_RELEASE_ASSET_SUFFIX }}")" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >> "$GITHUB_PATH" - name: Run ShellCheck @@ -93,7 +93,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >> "$GITHUB_ENV" - name: Checkout repository @@ -121,7 +121,7 @@ jobs: # Standardize binary name mv "${{ env.SHFMT_INSTALL_PATH }}/${{ steps.download.outputs.name }}" "${{ env.SHFMT_INSTALL_PATH }}/shfmt" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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 fb7b85f4..1478d16c 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-workflows-task.yml b/.github/workflows/check-workflows-task.yml index b008a44f..e75bed47 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/master/workflow-templates/check-workflows-task.md name: Check Workflows -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-yaml-task.yml b/.github/workflows/check-yaml-task.yml index 29df5d84..f8742bbc 100644 --- a/.github/workflows/check-yaml-task.yml +++ b/.github/workflows/check-yaml-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/spell-check-task.yml b/.github/workflows/spell-check-task.yml index 3529024e..7db2aeb0 100644 --- a/.github/workflows/spell-check-task.yml +++ b/.github/workflows/spell-check-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: pull_request: diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 986bda6f..3a330c12 100644 --- a/.github/workflows/sync-labels.yml +++ b/.github/workflows/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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -85,7 +85,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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 7d4d6ea6..2309cccf 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/en/actions/reference/events-that-trigger-workflows#workflow_dispatch + # See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch workflow_dispatch: env: @@ -103,7 +103,7 @@ jobs: - name: Set install path environment variable shell: bash run: | - # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "BINDIR=${{ runner.temp }}/custom-installation-folder" >> "$GITHUB_ENV" - name: Download script artifact @@ -209,7 +209,7 @@ jobs: - name: Set install path environment variables shell: bash run: | - # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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" @@ -239,7 +239,7 @@ jobs: - name: Add first installation to PATH shell: bash run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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 943ce64c..015f4304 100644 --- a/.github/workflows/test-python-poetry-task.yml +++ b/.github/workflows/test-python-poetry-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/README.md b/README.md index 4655fc59..8a232e21 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ The [Arduino](https://www.arduino.cc/) Tooling Team's collection of reusable pro ## GitHub Actions workflow templates -The [`workflow-templates` folder](workflow-templates) contains a collection of [GitHub Actions workflows](https://docs.github.com/en/actions/quickstart#creating-your-first-workflow) which can be used in any applicable repository either as-is or with minor project-specific configuration. +The [`workflow-templates` folder](workflow-templates) contains a collection of [GitHub Actions workflows](https://docs.github.com/actions/quickstart#creating-your-first-workflow) which can be used in any applicable repository either as-is or with minor project-specific configuration. More information available [here](workflow-templates#readme). diff --git a/issue-templates/README.md b/issue-templates/README.md index cc570070..9fff167f 100644 --- a/issue-templates/README.md +++ b/issue-templates/README.md @@ -2,7 +2,7 @@ A menu of issue categories will be presented when the user begins the issue creation process. This "template chooser" also contains links to relevant information, which can redirect support requests or other inappropriate/unproductive uses of the issue tracker. -A link to the default organization level [security policy](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository) (using [the default organization-level one](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) if one is not present for the repository) is displayed in the template chooser, helping to ensure that vulnerability disclosures are done according to policy. +A link to the default organization level [security policy](https://docs.github.com/code-security/getting-started/adding-a-security-policy-to-your-repository) (using [the default organization-level one](https://docs.github.com/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file) if one is not present for the repository) is displayed in the template chooser, helping to ensure that vulnerability disclosures are done according to policy. If none of the issue types are applicable, the user can click the "Open a blank issue" link at the bottom of the issue template chooser page to get the previous issue creation behavior. @@ -17,5 +17,5 @@ Each subfolder contains a set of issue templates for a specific application. Doc ## References -- https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates -- https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +- https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates +- https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser diff --git a/issue-templates/minimal/README.md b/issue-templates/minimal/README.md index 84ca75fb..b715f590 100644 --- a/issue-templates/minimal/README.md +++ b/issue-templates/minimal/README.md @@ -25,7 +25,7 @@ Replace `REPO_OWNER/REPO_NAME` in the `contact_links[0].url` field of `config.ym Add links for any additional relevant resources to the `contact_links[]` field of `config.yml`. -Reference: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser +Reference: https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser ## Commit message @@ -48,12 +48,12 @@ process. ## PR message ```markdown -Although providing a structured template for filling information into an issue report is not appropriate for this project, the [GitHub issue template](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) system offers some additional useful features for automating issue tracker maintenance tasks: +Although providing a structured template for filling information into an issue report is not appropriate for this project, the [GitHub issue template](https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) system offers some additional useful features for automating issue tracker maintenance tasks: -- [Template chooser](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser) allows redirecting support requests via "Contact Links", and also provides a prominent link to +- [Template chooser](https://docs.github.com/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser) allows redirecting support requests via "Contact Links", and also provides a prominent link to security policy to guide vulnerability disclosures. - Encouraging the reporter to fit their report into a specific issue category results in more clarity. -- Automatic [labeling](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels) according to template choice allows the reporter to do the initial classification. +- Automatic [labeling](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels) according to template choice allows the reporter to do the initial classification. This minimal issue template system provides these benefits without making any changes to the actual issue writing process. ``` diff --git a/issue-templates/template-choosers/github-actions/config.yml b/issue-templates/template-choosers/github-actions/config.yml index a70c3eb0..e62e7705 100644 --- a/issue-templates/template-choosers/github-actions/config.yml +++ b/issue-templates/template-choosers/github-actions/config.yml @@ -6,7 +6,7 @@ contact_links: url: https://github.com/REPO_OWNER/REPO_NAME#readme about: Detailed usage documentation is available here. - name: Learn about GitHub Actions - url: https://docs.github.com/en/actions + url: https://docs.github.com/actions about: Everything you need to know to get started with GitHub Actions. - name: Support request url: https://forum.arduino.cc/ diff --git a/other/installation-script/installation.md b/other/installation-script/installation.md index 8502e8c2..4c9bcdee 100644 --- a/other/installation-script/installation.md +++ b/other/installation-script/installation.md @@ -21,7 +21,7 @@ curl -fsSL https://raw.githubusercontent.com/arduino/REPO_NAME/main/etc/install. ``` If you would like to use the `REPO_NAME` command from any location, install PRODUCT_NAME to a directory already in -your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the PRODUCT_NAME installation path to your +your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the PRODUCT_NAME installation path to your `PATH` environment variable. If you want to download a specific PRODUCT_NAME version, for example `0.9.0` or `nightly-latest`, pass the version @@ -36,7 +36,7 @@ curl -fsSL https://raw.githubusercontent.com/arduino/REPO_NAME/main/etc/install. Pre-built binaries for all the supported platforms are available for download from the links below. If you would like to use the `REPO_NAME` command from any location, extract the downloaded file to a directory already -in your [`PATH`](https://en.wikipedia.org/wiki/PATH%5F%28variable%29) or add the PRODUCT_NAME installation path to your +in your [`PATH`](https://wikipedia.org/wiki/PATH%5F%28variable%29) or add the PRODUCT_NAME installation path to your `PATH` environment variable. ### Latest release diff --git a/workflow-templates/README.md b/workflow-templates/README.md index c6f7bded..8d8a3b9e 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/en/actions/quickstart#creating-your-first-workflow). +A collection of reusable [GitHub Actions workflows](https://docs.github.com/actions/quickstart#creating-your-first-workflow). ## Documentation diff --git a/workflow-templates/assets/dependabot/README.md b/workflow-templates/assets/dependabot/README.md index f827b5fc..b8ee877f 100644 --- a/workflow-templates/assets/dependabot/README.md +++ b/workflow-templates/assets/dependabot/README.md @@ -2,7 +2,7 @@ Dependabot can be used to check for outdated action versions used in the repository's GitHub Actions workflows: -https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot +https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot ## Instructions @@ -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/en/actions/creating-actions/about-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/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. 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. @@ -29,7 +29,7 @@ NOTE: Dependabot's PRs will occasionally propose to pin to the patch version of (e.g., `uses: foo/bar@v2`). Dependabot will automatically close its PR once the workflow has been updated. More information: -https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot +https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot ``` ## PR message @@ -37,10 +37,10 @@ https://docs.github.com/en/github/administering-a-repository/keeping-your-action ```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/en/actions/creating-actions/about-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/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. 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. More information: -https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot +https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot ``` diff --git a/workflow-templates/assets/dependabot/dependabot.yml b/workflow-templates/assets/dependabot/dependabot.yml index f2bfa724..fd7388a9 100644 --- a/workflow-templates/assets/dependabot/dependabot.yml +++ b/workflow-templates/assets/dependabot/dependabot.yml @@ -1,10 +1,10 @@ -# See: https://docs.github.com/en/code-security/supply-chain-security/configuration-options-for-dependency-updates#about-the-dependabotyml-file +# See: https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#about-the-dependabotyml-file version: 2 updates: # Configure check for outdated GitHub Actions actions in workflows. # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/dependabot/README.md - # See: https://docs.github.com/en/code-security/supply-chain-security/keeping-your-actions-up-to-date-with-dependabot + # See: https://docs.github.com/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot - package-ecosystem: github-actions directory: / # Check the repository's workflows under /.github/workflows/ schedule: diff --git a/workflow-templates/check-certificates.md b/workflow-templates/check-certificates.md index 2cda601d..b730a6e0 100644 --- a/workflow-templates/check-certificates.md +++ b/workflow-templates/check-certificates.md @@ -22,7 +22,7 @@ Replace `REPO_OWNER/REPO_NAME` with the repository's name in the `jobs.check-cer 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/en/actions/reference/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/security-guides/encrypted-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 ebf79d25..03c8e580 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -41,7 +41,7 @@ jobs: steps: - name: Set certificate path environment variable run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "CERTIFICATE_PATH=${{ runner.temp }}/certificate.p12" >> "$GITHUB_ENV" - name: Decode certificate diff --git a/workflow-templates/check-general-formatting-task.yml b/workflow-templates/check-general-formatting-task.yml index e1c202b6..feaceb00 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: pull_request: @@ -18,7 +18,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >> "$GITHUB_ENV" - name: Checkout repository @@ -46,7 +46,7 @@ jobs: # Give the binary a standard name mv "${{ env.EC_INSTALL_PATH }}/bin/ec-linux-amd64" "${{ env.EC_INSTALL_PATH }}/bin/ec" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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 1ba7c450..8a916454 100644 --- a/workflow-templates/check-go-dependencies-task.md +++ b/workflow-templates/check-go-dependencies-task.md @@ -51,7 +51,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/en/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/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. #### Unrecognized licenses diff --git a/workflow-templates/check-go-dependencies-task.yml b/workflow-templates/check-go-dependencies-task.yml index 7a557eed..29e24995 100644 --- a/workflow-templates/check-go-dependencies-task.yml +++ b/workflow-templates/check-go-dependencies-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/v2#readme GO_VERSION: "1.16" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-go-task.md b/workflow-templates/check-go-task.md index 4fc1c707..172081dd 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 Configure the version of Go used for development of the project in the `env.GO_VERSION` field of `check-go-task.yml`. -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/en/actions/reference/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/using-workflows/workflow-syntax-for-github-actions#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 a3903ca5..4e509e72 100644 --- a/workflow-templates/check-go-task.yml +++ b/workflow-templates/check-go-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/v2#readme GO_VERSION: "1.16" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/check-license.md b/workflow-templates/check-license.md index b9466d41..ea6a2bd0 100644 --- a/workflow-templates/check-license.md +++ b/workflow-templates/check-license.md @@ -1,6 +1,6 @@ # "Check License" workflow -Check whether the repository's license file is recognizable by GitHub's [automated license detection system](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#detecting-a-license) and whether it is recognized as the correct type. In order to be detected (and to ensure it remains a valid legal instrument), the license text must not be modified. GitHub supports multiple license filenames, so it's also possible that the license type could be inadvertently changed by the addition of a file to the repository. +Check whether the repository's license file is recognizable by GitHub's [automated license detection system](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#detecting-a-license) and whether it is recognized as the correct type. In order to be detected (and to ensure it remains a valid legal instrument), the license text must not be modified. GitHub supports multiple license filenames, so it's also possible that the license type could be inadvertently changed by the addition of a file to the repository. Please always use the exact license text from the links at https://choosealicense.com/appendix/ @@ -61,7 +61,7 @@ changes which would change the license type or which license file is used by the ```markdown Whenever one of the recognized license file names are modified in the repository, the workflow runs [licensee](https://github.com/licensee/licensee) to check whether the license can be recognized and whether it is of the expected type. -GitHub has a useful [automated license detection system](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/licensing-a-repository#detecting-a-license) that determines the license type used by a repository, and surfaces that information in the repository home page, the search web interface, and the GitHub API. This license detection system requires that the license be defined by a dedicated file with one of several standardized filenames and paths. +GitHub has a useful [automated license detection system](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository#detecting-a-license) that determines the license type used by a repository, and surfaces that information in the repository home page, the search web interface, and the GitHub API. This license detection system requires that the license be defined by a dedicated file with one of several standardized filenames and paths. GitHub's license detection system uses the popular licensee tool, so this file also serves to define the license type for any other usages of licensee, as well as to human readers of the file. diff --git a/workflow-templates/check-license.yml b/workflow-templates/check-license.yml index 73b9df89..04536aef 100644 --- a/workflow-templates/check-license.yml +++ b/workflow-templates/check-license.yml @@ -8,7 +8,7 @@ env: # TODO: Define the project's license type here EXPECTED_LICENSE_TYPE: AGPL-3.0 -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-markdown-task.yml b/workflow-templates/check-markdown-task.yml index a308265c..4153c666 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-mkdocs-task.yml b/workflow-templates/check-mkdocs-task.yml index c4c85c52..b8ade4ac 100644 --- a/workflow-templates/check-mkdocs-task.yml +++ b/workflow-templates/check-mkdocs-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-prettier-formatting-task.yml b/workflow-templates/check-prettier-formatting-task.yml index 68247c87..7e4ac7a3 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/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-python-task.yml b/workflow-templates/check-python-task.yml index 9a09adb1..38553f00 100644 --- a/workflow-templates/check-python-task.yml +++ b/workflow-templates/check-python-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-shell-task.yml b/workflow-templates/check-shell-task.yml index fa305077..90d985ff 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -50,7 +50,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >> "$GITHUB_ENV" - name: Checkout repository @@ -77,7 +77,7 @@ jobs: tar --extract --file="${{ steps.download.outputs.name }}" EXTRACTION_FOLDER="$(basename "${{ steps.download.outputs.name }}" "${{ env.SHELLCHECK_RELEASE_ASSET_SUFFIX }}")" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >> "$GITHUB_PATH" - name: Run ShellCheck @@ -93,7 +93,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >> "$GITHUB_ENV" - name: Checkout repository @@ -121,7 +121,7 @@ jobs: # Standardize binary name mv "${{ env.SHFMT_INSTALL_PATH }}/${{ steps.download.outputs.name }}" "${{ env.SHFMT_INSTALL_PATH }}/shfmt" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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 fb7b85f4..1478d16c 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-toc-task.yml b/workflow-templates/check-toc-task.yml index 33aaadd9..7df8511c 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-workflows-task.yml b/workflow-templates/check-workflows-task.yml index 5b5287c5..cab7c7af 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/master/workflow-templates/check-workflows-task.md name: Check Workflows -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/check-yaml-task.yml b/workflow-templates/check-yaml-task.yml index 29df5d84..f8742bbc 100644 --- a/workflow-templates/check-yaml-task.yml +++ b/workflow-templates/check-yaml-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/README.md b/workflow-templates/dependabot/README.md index 27a79fe6..dd221f04 100644 --- a/workflow-templates/dependabot/README.md +++ b/workflow-templates/dependabot/README.md @@ -1,12 +1,12 @@ # Outdated GitHub Actions action version check -Dependabot is used to [check for outdated action versions](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot) used in the template workflows. +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. -The files under `workflow-templates/dependabot/workflow-template-copies/.github/workflows/` are duplicates of the files under `workflow-templates/`. This is done as a workaround for the lack of support for defining exact workflow folders in the Dependabot configuration (it always checks the YAML files in the `.github/workflows/` subfolder of the path specified via the `updates[].directory` configuration key of [`dependabot.yml`](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file). +The files under `workflow-templates/dependabot/workflow-template-copies/.github/workflows/` are duplicates of the files under `workflow-templates/`. This is done as a workaround for the lack of support for defining exact workflow folders in the Dependabot configuration (it always checks the YAML files in the `.github/workflows/` subfolder of the path specified via the `updates[].directory` configuration key of [`dependabot.yml`](https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#about-the-dependabotyml-file). So do not merge the PRs from Dependabot for the files under `workflow-templates/dependabot-copies/.github/workflows/`. The equivalent workflow templates directly under `workflow-templates/` must be updated instead. The Dependabot PRs for these files are used only as notifications of available action updates. -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/en/actions/creating-actions/about-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/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 will automatically close its PR once the workflow has been updated. diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-certificates.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-certificates.yml index ebf79d25..03c8e580 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-certificates.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -41,7 +41,7 @@ jobs: steps: - name: Set certificate path environment variable run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "CERTIFICATE_PATH=${{ runner.temp }}/certificate.p12" >> "$GITHUB_ENV" - name: Decode certificate diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-general-formatting-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-general-formatting-task.yml index e1c202b6..feaceb00 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-general-formatting-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: pull_request: @@ -18,7 +18,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >> "$GITHUB_ENV" - name: Checkout repository @@ -46,7 +46,7 @@ jobs: # Give the binary a standard name mv "${{ env.EC_INSTALL_PATH }}/bin/ec-linux-amd64" "${{ env.EC_INSTALL_PATH }}/bin/ec" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.EC_INSTALL_PATH }}/bin" >> "$GITHUB_PATH" - name: Check formatting diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-dependencies-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-dependencies-task.yml index 7a557eed..29e24995 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-dependencies-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-dependencies-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/v2#readme GO_VERSION: "1.16" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-task.yml index a3903ca5..4e509e72 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-go-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/v2#readme GO_VERSION: "1.16" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-license.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-license.yml index 73b9df89..04536aef 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-license.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-license.yml @@ -8,7 +8,7 @@ env: # TODO: Define the project's license type here EXPECTED_LICENSE_TYPE: AGPL-3.0 -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-markdown-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-markdown-task.yml index a308265c..4153c666 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-markdown-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-mkdocs-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-mkdocs-task.yml index c4c85c52..b8ade4ac 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-mkdocs-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-mkdocs-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-prettier-formatting-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-prettier-formatting-task.yml index 68247c87..7e4ac7a3 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-prettier-formatting-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.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/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-python-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-python-task.yml index 9a09adb1..38553f00 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-python-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-python-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-shell-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-shell-task.yml index fa305077..90d985ff 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-shell-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -50,7 +50,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >> "$GITHUB_ENV" - name: Checkout repository @@ -77,7 +77,7 @@ jobs: tar --extract --file="${{ steps.download.outputs.name }}" EXTRACTION_FOLDER="$(basename "${{ steps.download.outputs.name }}" "${{ env.SHELLCHECK_RELEASE_ASSET_SUFFIX }}")" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >> "$GITHUB_PATH" - name: Run ShellCheck @@ -93,7 +93,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#setting-an-environment-variable echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >> "$GITHUB_ENV" - name: Checkout repository @@ -121,7 +121,7 @@ jobs: # Standardize binary name mv "${{ env.SHFMT_INSTALL_PATH }}/${{ steps.download.outputs.name }}" "${{ env.SHFMT_INSTALL_PATH }}/shfmt" # Add installation to PATH: - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#adding-a-system-path + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.SHFMT_INSTALL_PATH }}" >> "$GITHUB_PATH" - name: Format shell scripts diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-taskfiles.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-taskfiles.yml index fb7b85f4..1478d16c 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-taskfiles.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-toc-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-toc-task.yml index 33aaadd9..7df8511c 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-toc-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-workflows-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-workflows-task.yml index 5b5287c5..cab7c7af 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-workflows-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-workflows-task.yml @@ -1,7 +1,7 @@ # Source: https://github.com/arduino/tooling-project-assets/blob/master/workflow-templates/check-workflows-task.md name: Check Workflows -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-yaml-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-yaml-task.yml index 29df5d84..f8742bbc 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-yaml-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/check-yaml-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/deploy-mkdocs-poetry.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/deploy-mkdocs-poetry.yml index 8df9bed3..6cb3e289 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/deploy-mkdocs-poetry.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/deploy-mkdocs-poetry.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: branches: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/publish-go-nightly-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/publish-go-nightly-task.yml index 1b591d0d..79e80e8a 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/publish-go-nightly-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/publish-go-nightly-task.yml @@ -10,7 +10,7 @@ env: AWS_PLUGIN_TARGET: TODO ARTIFACT_NAME: dist -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: schedule: # run every day at 1AM diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/publish-go-tester-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/publish-go-tester-task.yml index c3bdeaca..6c21a09f 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/publish-go-tester-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/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/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/release-tag.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/release-tag.yml index 6728894b..c974012e 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/release-tag.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/release-tag.yml @@ -17,7 +17,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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/dependabot/workflow-template-copies/.github/workflows/spell-check-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/spell-check-task.yml index 3529024e..7db2aeb0 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/spell-check-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/spell-check-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: pull_request: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/sync-labels.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/sync-labels.yml index 986bda6f..3a330c12 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/sync-labels.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -85,7 +85,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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/dependabot/workflow-template-copies/.github/workflows/test-go-integration-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-go-integration-task.yml index e1c4ab71..79ee2505 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-go-integration-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-go-integration-task.yml @@ -7,7 +7,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-go-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-go-task.yml index b3da369e..bd1a68ea 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-go-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-go-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/v2#readme GO_VERSION: "1.16" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-python-poetry-task.yml b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-python-poetry-task.yml index 943ce64c..015f4304 100644 --- a/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-python-poetry-task.yml +++ b/workflow-templates/dependabot/workflow-template-copies/.github/workflows/test-python-poetry-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/deploy-mkdocs-poetry.yml b/workflow-templates/deploy-mkdocs-poetry.yml index 8df9bed3..6cb3e289 100644 --- a/workflow-templates/deploy-mkdocs-poetry.yml +++ b/workflow-templates/deploy-mkdocs-poetry.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/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 a72c4184..22bc9788 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/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) must be defined: +In addition, the following [repository secret](https://docs.github.com/actions/security-guides/encrypted-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 1b591d0d..79e80e8a 100644 --- a/workflow-templates/publish-go-nightly-task.yml +++ b/workflow-templates/publish-go-nightly-task.yml @@ -10,7 +10,7 @@ env: AWS_PLUGIN_TARGET: TODO ARTIFACT_NAME: dist -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: schedule: # run every day at 1AM diff --git a/workflow-templates/publish-go-tester-task.md b/workflow-templates/publish-go-tester-task.md index 2d16c34c..1a94228b 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/en/actions/guides/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/using-workflows/storing-workflow-data-as-artifacts) 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. @@ -58,7 +58,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/en/actions/guides/storing-workflow-data-as-artifacts). +- Upload the builds as [workflow artifacts](https://docs.github.com/actions/using-workflows/storing-workflow-data-as-artifacts). 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 c3bdeaca..6c21a09f 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/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/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 94f03c2b..3f7ca20f 100644 --- a/workflow-templates/release-go-crosscompile-task.md +++ b/workflow-templates/release-go-crosscompile-task.md @@ -48,9 +48,9 @@ The following project-specific variables must be set in `gon.config.hcl`: #### Repository secrets -The following [repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) must be defined: +The following [repository secrets](https://docs.github.com/actions/security-guides/encrypted-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://en.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_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. - `AC_USERNAME` - the Apple ID username associated with the certificate. - **Note**: not likely to be a problem when using Arduino's standard credentials, but in the event the username is a member of multiple Apple Developer Program teams, you will also need to define the App Store Connect provider via [the `AC_PROVIDER` environment variable](https://github.com/mitchellh/gon#configuration-file). You can use the ID of the certificate identity (e.g., `7KT7ZWMCJT`) for this. @@ -102,7 +102,7 @@ On every push of a tag named with a version format: - Build the project for all supported platforms. - Use [gon](https://github.com/mitchellh/gon) to sign and notarize the macOS build. -- Create a [GitHub release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/about-releases). +- Create a [GitHub release](https://docs.github.com/repositories/releasing-projects-on-github/about-releases). - Builds and checksums are attached as release assets - A changelog generated by [`arduino/create-changelog`](https://github.com/arduino/create-changelog) from the commit history is added to the release description - If the tag has [a pre-release version suffix](https://semver.org/), the GitHub release will be marked as a pre-release. diff --git a/workflow-templates/release-go-task.md b/workflow-templates/release-go-task.md index 28f36287..d0274d5b 100644 --- a/workflow-templates/release-go-task.md +++ b/workflow-templates/release-go-task.md @@ -47,9 +47,9 @@ The following project-specific variables must be set in `gon.config.hcl`: #### Repository secrets -The following [repository secrets](https://docs.github.com/en/actions/reference/encrypted-secrets#creating-encrypted-secrets-for-a-repository) must be defined: +The following [repository secrets](https://docs.github.com/actions/security-guides/encrypted-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://en.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_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. - `AC_USERNAME` - the Apple ID username associated with the certificate. - **Note**: not likely to be a problem when using Arduino's standard credentials, but in the event the username is a member of multiple Apple Developer Program teams, you will also need to define the App Store Connect provider via [the `AC_PROVIDER` environment variable](https://github.com/mitchellh/gon#configuration-file). You can use the ID of the certificate identity (e.g., `7KT7ZWMCJT`) for this. @@ -101,7 +101,7 @@ On every push of a tag named with a version format: - Build the project for all supported platforms. - Use [gon](https://github.com/mitchellh/gon) to sign and notarize the macOS build. -- Create a [GitHub release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/about-releases). +- Create a [GitHub release](https://docs.github.com/repositories/releasing-projects-on-github/about-releases). - Builds and checksums are attached as release assets - A changelog generated by [`arduino/create-changelog`](https://github.com/arduino/create-changelog) from the commit history is added to the release description - If the tag has [a pre-release version suffix](https://semver.org/), the GitHub release will be marked as a pre-release. diff --git a/workflow-templates/release-tag.md b/workflow-templates/release-tag.md index b97e49ba..b3ae3723 100644 --- a/workflow-templates/release-tag.md +++ b/workflow-templates/release-tag.md @@ -1,6 +1,6 @@ # "Release" workflow -Make a [GitHub release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/about-releases) with changelog on release [tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) push. +Make a [GitHub release](https://docs.github.com/repositories/releasing-projects-on-github/about-releases) with changelog on release [tag](https://git-scm.com/book/en/v2/Git-Basics-Tagging) push. ## Installation @@ -42,7 +42,7 @@ Tags that contain a pre-release version will cause the GitHub release to be mark ## PR message ```markdown -On every push of a release tag (e.g., `1.2.3` or `v1.2.3`) to the repository, create a [GitHub release](https://docs.github.com/en/github/administering-a-repository/releasing-projects-on-github/about-releases) with a raw [changelog generated](https://github.com/arduino/create-changelog) from the commit history since the last release tag. +On every push of a release tag (e.g., `1.2.3` or `v1.2.3`) to the repository, create a [GitHub release](https://docs.github.com/repositories/releasing-projects-on-github/about-releases) with a raw [changelog generated](https://github.com/arduino/create-changelog) from the commit history since the last release tag. Tags that contain a [pre-release version](https://semver.org/#spec-item-9) will cause the GitHub release to be marked as a pre-release. ``` diff --git a/workflow-templates/release-tag.yml b/workflow-templates/release-tag.yml index 6728894b..c974012e 100644 --- a/workflow-templates/release-tag.yml +++ b/workflow-templates/release-tag.yml @@ -17,7 +17,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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 3529024e..7db2aeb0 100644 --- a/workflow-templates/spell-check-task.yml +++ b/workflow-templates/spell-check-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: pull_request: diff --git a/workflow-templates/sync-labels.md b/workflow-templates/sync-labels.md index be4eb22e..7441a0a4 100644 --- a/workflow-templates/sync-labels.md +++ b/workflow-templates/sync-labels.md @@ -1,6 +1,6 @@ # "Sync Labels" workflow -Use [github-label-sync](https://github.com/Financial-Times/github-label-sync) to configure the repository's [issue/pull request labels](https://docs.github.com/en/github/managing-your-work-on-github/managing-labels) according to the universal, shared, and local label configuration files. +Use [github-label-sync](https://github.com/Financial-Times/github-label-sync) to configure the repository's [issue/pull request labels](https://docs.github.com/issues/using-labels-and-milestones-to-track-work/managing-labels) according to the universal, shared, and local label configuration files. Use of consistent labels across repositories makes repository maintenance and searching of issue and pull request trackers easier. diff --git a/workflow-templates/sync-labels.yml b/workflow-templates/sync-labels.yml index 986bda6f..3a330c12 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/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: push: paths: @@ -85,7 +85,7 @@ jobs: steps: - name: Set environment variables run: | - # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable + # See: https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#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 e1c4ab71..79ee2505 100644 --- a/workflow-templates/test-go-integration-task.yml +++ b/workflow-templates/test-go-integration-task.yml @@ -7,7 +7,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: diff --git a/workflow-templates/test-go-task.md b/workflow-templates/test-go-task.md index 1e1fc815..d00f4ae7 100644 --- a/workflow-templates/test-go-task.md +++ b/workflow-templates/test-go-task.md @@ -23,7 +23,7 @@ Install the [`test-go-task.yml`](test-go-task.yml) GitHub Actions workflow to `. Configure the version of Go used for development of the project in the `env.GO_VERSION` field of `test-go-task.yml`. -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/en/actions/reference/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/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` Replace `REPO_OWNER/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 b3da369e..bd1a68ea 100644 --- a/workflow-templates/test-go-task.yml +++ b/workflow-templates/test-go-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/v2#readme GO_VERSION: "1.16" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/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 943ce64c..015f4304 100644 --- a/workflow-templates/test-python-poetry-task.yml +++ b/workflow-templates/test-python-poetry-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python PYTHON_VERSION: "3.9" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows on: create: push: