From e31e97804e478a2c32f72740dd73c877067592f3 Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 14 Oct 2024 19:48:24 -0700 Subject: [PATCH] Update redirecting URLs in reference links The templates and documentation contain reference links to provide additional information to the users and maintainers. The targets of some of these links have moved since the time they were added. Although the user could still reach the intended content via a redirect, it is best not to rely on redirects continuing to work indefinitely. So the URLs are hereby updated to point directly to the target content. --- .github/dependabot.yml | 4 ++-- .github/workflows/check-certificates.yml | 4 ++-- .github/workflows/check-general-formatting-task.yml | 6 +++--- .github/workflows/check-go-dependencies-task.yml | 2 +- .github/workflows/check-go-task.yml | 2 +- .github/workflows/check-license.yml | 2 +- .github/workflows/check-markdown-task.yml | 2 +- .github/workflows/check-mkdocs-task.yml | 2 +- .github/workflows/check-prettier-formatting-task.yml | 2 +- .github/workflows/check-python-task.yml | 2 +- .github/workflows/check-shell-task.yml | 10 +++++----- .github/workflows/check-workflows-task.yml | 4 ++-- .github/workflows/publish-go-nightly-task.yml | 2 +- .github/workflows/publish-go-tester-task.yml | 2 +- .github/workflows/spell-check-task.yml | 2 +- .github/workflows/sync-labels.yml | 4 ++-- .github/workflows/test-go-integration-task.yml | 2 +- .github/workflows/test-go-task.yml | 2 +- .github/workflows/test-install.yml | 4 ++-- .licensed.yml | 2 +- 20 files changed, 31 insertions(+), 31 deletions(-) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 5d0617828..528b07ab0 100644 --- a/.github/dependabot.yml +++ b/.github/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/ assignees: diff --git a/.github/workflows/check-certificates.yml b/.github/workflows/check-certificates.yml index 94e4d9662..b92fbb147 100644 --- a/.github/workflows/check-certificates.yml +++ b/.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/writing-workflows/choosing-when-your-workflow-runs/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/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable echo "CERTIFICATE_PATH=${{ runner.temp }}/certificate.p12" >> "$GITHUB_ENV" - name: Decode certificate diff --git a/.github/workflows/check-general-formatting-task.yml b/.github/workflows/check-general-formatting-task.yml index 1a2924050..d3370df34 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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: pull_request: @@ -20,7 +20,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/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable echo "EC_INSTALL_PATH=${{ runner.temp }}/editorconfig-checker" >> "$GITHUB_ENV" - name: Checkout repository @@ -48,7 +48,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/writing-workflows/choosing-what-your-workflow-does/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-go-dependencies-task.yml b/.github/workflows/check-go-dependencies-task.yml index a1a81f541..e27516c9e 100644 --- a/.github/workflows/check-go-dependencies-task.yml +++ b/.github/workflows/check-go-dependencies-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax GO_VERSION: "1.17" -# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows +# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-go-task.yml b/.github/workflows/check-go-task.yml index 246e60e3f..14bb3b950 100644 --- a/.github/workflows/check-go-task.yml +++ b/.github/workflows/check-go-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax GO_VERSION: "1.17" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/check-license.yml b/.github/workflows/check-license.yml index 73e9a31ba..94ec9b59b 100644 --- a/.github/workflows/check-license.yml +++ b/.github/workflows/check-license.yml @@ -6,7 +6,7 @@ env: # SPDX identifier: https://spdx.org/licenses/ EXPECTED_LICENSE_TYPE: GPL-3.0 -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-markdown-task.yml b/.github/workflows/check-markdown-task.yml index 5b241bf8e..5d6a78637 100644 --- a/.github/workflows/check-markdown-task.yml +++ b/.github/workflows/check-markdown-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax GO_VERSION: "1.17" -# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-mkdocs-task.yml b/.github/workflows/check-mkdocs-task.yml index 647b2289f..bb141c584 100644 --- a/.github/workflows/check-mkdocs-task.yml +++ b/.github/workflows/check-mkdocs-task.yml @@ -7,7 +7,7 @@ env: # See: https://github.com/actions/setup-python/tree/main#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/writing-workflows/choosing-when-your-workflow-runs/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 a3903857f..f6925e749 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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-python-task.yml b/.github/workflows/check-python-task.yml index 58ebc9e49..d2bfd3d1a 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/main#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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/check-shell-task.yml b/.github/workflows/check-shell-task.yml index ad00e04e3..1ad6cf884 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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: paths: @@ -52,7 +52,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/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable echo "INSTALL_PATH=${{ runner.temp }}/shellcheck" >> "$GITHUB_ENV" - name: Checkout repository @@ -79,7 +79,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/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path echo "${{ env.INSTALL_PATH }}/$EXTRACTION_FOLDER" >> "$GITHUB_PATH" - name: Run ShellCheck @@ -97,7 +97,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/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable echo "SHFMT_INSTALL_PATH=${{ runner.temp }}/shfmt" >> "$GITHUB_ENV" - name: Checkout repository @@ -125,7 +125,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/writing-workflows/choosing-what-your-workflow-does/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-workflows-task.yml b/.github/workflows/check-workflows-task.yml index 206eff348..607cfeb0a 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 +# Source: https://github.com/arduino/tooling-project-assets/blob/main/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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: paths: diff --git a/.github/workflows/publish-go-nightly-task.yml b/.github/workflows/publish-go-nightly-task.yml index f6b8a84b2..aca6c365c 100644 --- a/.github/workflows/publish-go-nightly-task.yml +++ b/.github/workflows/publish-go-nightly-task.yml @@ -10,7 +10,7 @@ env: AWS_PLUGIN_TARGET: /arduino-lint/ ARTIFACT_PREFIX: dist- -# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows +# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: schedule: # run every day at 1AM diff --git a/.github/workflows/publish-go-tester-task.yml b/.github/workflows/publish-go-tester-task.yml index 5842ed106..6dcba001c 100644 --- a/.github/workflows/publish-go-tester-task.yml +++ b/.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/actions/using-workflows/events-that-trigger-workflows +# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/spell-check-task.yml b/.github/workflows/spell-check-task.yml index 24b72b09d..81103b33a 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/main#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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: pull_request: diff --git a/.github/workflows/sync-labels.yml b/.github/workflows/sync-labels.yml index 8db4ecb56..baf3996f1 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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: push: paths: @@ -92,7 +92,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/writing-workflows/choosing-what-your-workflow-does/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-go-integration-task.yml b/.github/workflows/test-go-integration-task.yml index f283e71e7..31884d114 100644 --- a/.github/workflows/test-go-integration-task.yml +++ b/.github/workflows/test-go-integration-task.yml @@ -7,7 +7,7 @@ env: # See: https://github.com/actions/setup-python/tree/main#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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/test-go-task.yml b/.github/workflows/test-go-task.yml index 10de87c63..78b10ccd0 100644 --- a/.github/workflows/test-go-task.yml +++ b/.github/workflows/test-go-task.yml @@ -5,7 +5,7 @@ env: # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax GO_VERSION: "1.17" -# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows +# See: https://docs.github.com/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows on: create: push: diff --git a/.github/workflows/test-install.yml b/.github/workflows/test-install.yml index 41d147d80..60391124e 100644 --- a/.github/workflows/test-install.yml +++ b/.github/workflows/test-install.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/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#workflow_dispatch workflow_dispatch: env: @@ -64,7 +64,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/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable echo "BINDIR=${{ runner.temp }}/custom-installation-folder" >> "$GITHUB_ENV" - name: Checkout repository diff --git a/.licensed.yml b/.licensed.yml index e5d7179fa..a1a723ea3 100644 --- a/.licensed.yml +++ b/.licensed.yml @@ -1,4 +1,4 @@ -# See: https://github.com/github/licensed/blob/master/docs/configuration.md +# See: https://github.com/github/licensed/blob/main/docs/configuration.md sources: go: true