-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
update(doc): add version to avoid error when copy pasting examples #8
Conversation
Signed-off-by: Antoine Barthelemy <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Ant0wan Hi Antoine, thank you for your contribution!
(suggestion) WDYT about using major instead of full version in the examples? That way, users won't need to change their workflows to rely on up to date minor and patch releases.
@kislerdm Yep, I think it is a better idea. However we need a Like in this example ➜ git remote -v
origin [email protected]:actions/checkout (fetch)
origin [email protected]: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 |
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
Co-authored-by: Dmitry Kisler <[email protected]> Signed-off-by: Antoine Barthelemy <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: