From 2dbd3a41bd3c33c4837610d4eb416f0da663c8d4 Mon Sep 17 00:00:00 2001 From: per1234 Date: Tue, 14 Jun 2022 09:31:54 -0700 Subject: [PATCH] Use non-version specific reference URLs for tool version workflow variables GitHub Actions actions are used by the workflows to set up development tools in the runner workspace. In order to facilitate updates to new versions of these tools, we set the version to be set up via environment variables at the top of the workflow. Since this variable definition is separate from the step using the action, it might not be immediately apparent to the maintainer which version syntaxes are supported. For this reason, comments were added with the URL to the relevant section of the consuming action's documentation. Previously, these URLs were made to point to the version of the documentation that matched the version of the action in use by the workflow. Since we only use a major version ref, the expectation was that this would only need to be updated rarely. However, it turned out that the major version bump cycle is significantly shorter than expected. In addition, it is easy to forget the update because action version update PRs are provided by Dependabot, which obviously won't update the URLs in the comments. So it will be best to use a URL that points to the documentation at the tip of the default branch of the action repository. The likelihood of the documentation provided by this URL not matching the behavior of the release version of the action in use is likely less than it is for an outdated URL. --- .github/workflows/check-go-dependencies-task.yml | 2 +- .github/workflows/check-go-task.yml | 2 +- .github/workflows/check-python-task.yml | 2 +- .github/workflows/check-registry.yml | 2 +- .github/workflows/check-yaml-task.yml | 2 +- .github/workflows/test-go-integration-task.yml | 4 ++-- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/workflows/check-go-dependencies-task.yml b/.github/workflows/check-go-dependencies-task.yml index 9266b909..502bc414 100644 --- a/.github/workflows/check-go-dependencies-task.yml +++ b/.github/workflows/check-go-dependencies-task.yml @@ -2,7 +2,7 @@ name: Check Go Dependencies env: - # See: https://github.com/actions/setup-go/tree/v3#readme + # 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 diff --git a/.github/workflows/check-go-task.yml b/.github/workflows/check-go-task.yml index 4fbbc774..83c82029 100644 --- a/.github/workflows/check-go-task.yml +++ b/.github/workflows/check-go-task.yml @@ -2,7 +2,7 @@ name: Check Go env: - # See: https://github.com/actions/setup-go/tree/v2#readme + # 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 diff --git a/.github/workflows/check-python-task.yml b/.github/workflows/check-python-task.yml index f260e021..c8fe4e35 100644 --- a/.github/workflows/check-python-task.yml +++ b/.github/workflows/check-python-task.yml @@ -2,7 +2,7 @@ name: Check Python env: - # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python + # 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 diff --git a/.github/workflows/check-registry.yml b/.github/workflows/check-registry.yml index 98f782bb..55a6334b 100644 --- a/.github/workflows/check-registry.yml +++ b/.github/workflows/check-registry.yml @@ -1,7 +1,7 @@ name: Check Registry Data File env: - # See: https://github.com/actions/setup-go/tree/v2#readme + # 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 diff --git a/.github/workflows/check-yaml-task.yml b/.github/workflows/check-yaml-task.yml index bafea2fc..d02262f8 100644 --- a/.github/workflows/check-yaml-task.yml +++ b/.github/workflows/check-yaml-task.yml @@ -2,7 +2,7 @@ name: Check YAML env: - # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python + # 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 diff --git a/.github/workflows/test-go-integration-task.yml b/.github/workflows/test-go-integration-task.yml index 200619ec..2e4e35dc 100644 --- a/.github/workflows/test-go-integration-task.yml +++ b/.github/workflows/test-go-integration-task.yml @@ -2,9 +2,9 @@ name: Test Integration env: - # See: https://github.com/actions/setup-go/tree/v2#readme + # See: https://github.com/actions/setup-go/tree/main#supported-version-syntax GO_VERSION: "1.17" - # See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python + # 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