Skip to content

Commit 0b222c7

Browse files
committed
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.
1 parent 712b2d4 commit 0b222c7

9 files changed

+11
-11
lines changed

.github/workflows/check-code-generation-task.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Check Code Generation
22

33
env:
4-
# See: https://github.com/actions/setup-go/tree/v2#readme
4+
# See: https://github.com/actions/setup-go/tree/main#supported-version-syntax
55
GO_VERSION: "1.17"
66

77
on:

.github/workflows/check-go-dependencies-task.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Check Go Dependencies
33

44
env:
5-
# See: https://github.com/actions/setup-go/tree/v3#readme
5+
# See: https://github.com/actions/setup-go/tree/main#supported-version-syntax
66
GO_VERSION: "1.17"
77

88
# See: https://docs.github.com/actions/using-workflows/events-that-trigger-workflows

.github/workflows/check-go-task.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Check Go
33

44
env:
5-
# See: https://github.com/actions/setup-go/tree/v2#readme
5+
# See: https://github.com/actions/setup-go/tree/main#supported-version-syntax
66
GO_VERSION: "1.17"
77

88
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

.github/workflows/check-mkdocs-task.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
name: Check Website
33

44
env:
5-
# See: https://github.com/actions/setup-go/tree/v2#readme
5+
# See: https://github.com/actions/setup-go/tree/main#supported-version-syntax
66
GO_VERSION: "1.17"
7-
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
7+
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
88
PYTHON_VERSION: "3.9"
99

1010
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

.github/workflows/check-python-task.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Check Python
33

44
env:
5-
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
5+
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
66
PYTHON_VERSION: "3.9"
77

88
# See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows

.github/workflows/deploy-cobra-mkdocs-versioned-poetry.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Deploy Website
33

44
env:
5-
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
5+
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
66
PYTHON_VERSION: "3.9"
77

88
on:

.github/workflows/spell-check-task.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Spell Check
33

44
env:
5-
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
5+
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
66
PYTHON_VERSION: "3.9"
77

88
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows

.github/workflows/test-go-integration-task.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
name: Test Integration
33

44
env:
5-
# See: https://github.com/actions/setup-go/tree/v2#readme
5+
# See: https://github.com/actions/setup-go/tree/main#supported-version-syntax
66
GO_VERSION: "1.17"
7-
# See: https://github.com/actions/setup-python/tree/v2#available-versions-of-python
7+
# See: https://github.com/actions/setup-python/tree/main#available-versions-of-python
88
PYTHON_VERSION: "3.9"
99

1010
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows

.github/workflows/test-go-task.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Test Go
33

44
env:
5-
# See: https://github.com/actions/setup-go/tree/v2#readme
5+
# See: https://github.com/actions/setup-go/tree/main#supported-version-syntax
66
GO_VERSION: "1.17"
77

88
# See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows

0 commit comments

Comments
 (0)