Closed Ant0wan closed 11 months ago
@kislerdm Yep, I think it is a better idea. However we need a v1
tag on the latest v1 version otherwise we will get this error:
Like in this example actions/checkout
repo:
➜ git remote -v
origin git@github.com:actions/checkout (fetch)
origin git@github.com:actions/checkout (push)
➜ git tag -l
1.0.0
v1
v1.0.0
v1.1.0
v1.2.0
v2
v2-beta
v2.0.0
v2.1.0
v2.1.1
v2.2.0
v2.3.0
v2.3.1
v2.3.2
v2.3.3
v2.3.4
v2.3.5
v2.4.0
v2.4.1
v2.4.2
v2.5.0
v2.6.0
v2.7.0
v3
v3.0.0
v3.0.1
v3.0.2
v3.1.0
v3.2.0
v3.3.0
v3.4.0
v3.5.0
v3.5.1
v3.5.2
v3.5.3
v3.6.0
v4
v4.0.0
v4.1.0
v4.1.1
Just updated the PR description here too.
In order to enhance the clarity and accuracy of our GitHub Action workflow examples, I am proposing a modification to the format used in the
uses
directive. This change aims to prevent potential errors and confusion for users.Currently, the documentation and examples include lines like this:
While this format is generic, it can sometimes lead to unexpected issues when inexperienced users are utilizing the action. To mitigate this, I recommend adopting a more explicit and precise format:
The addition of @ref (in this case,
@v1
) ensures that "fix". To illustrate why this change is important, I've provided an example of a failure scenario that occurred the first time I used setup-opentofu in this GitHub Action run: Link to Failed Run. In this run, the absence of @ref led to a Github Action related issue, showcasing the potential pitfalls of the current format. I understand that this change pertains to GitHub Action-specific user knowledge, but it can significantly benefit users, especially those who may not be familiar with the intricacies of action references.Please review and consider this proposal, and let me know if you have any questions or suggestions.
Screenshots: