1
0
mirror of https://github.com/arduino/library-registry.git synced 2025-05-25 19:22:32 +03:00

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.
This commit is contained in:
per1234 2022-06-14 09:31:54 -07:00
parent 4e90dca441
commit 2dbd3a41bd
6 changed files with 7 additions and 7 deletions

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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