X Tutup
The Wayback Machine - https://web.archive.org/web/20220707222846/https://github.com/github/docs/issues/17071
Skip to content
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

Clarify That GitHub Actions Don't Automatically Understand Semantic Versioning #17071

Open
1 task done
Kurt-von-Laven opened this issue Apr 13, 2022 · 9 comments · May be fixed by #17776
Open
1 task done

Clarify That GitHub Actions Don't Automatically Understand Semantic Versioning #17071

Kurt-von-Laven opened this issue Apr 13, 2022 · 9 comments · May be fixed by #17776
Labels
actions content help wanted SME reviewed

Comments

@Kurt-von-Laven
Copy link
Contributor

@Kurt-von-Laven Kurt-von-Laven commented Apr 13, 2022

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsuses

What part(s) of the article would you like to see updated?

Using the specific major action version allows you to receive critical fixes and security patches while still maintaining compatibility. It also assures that your workflow should still work.

This section can be read to imply that GitHub Actions understands semantic versioning, but it does not. In order for users to specify a major action version, the action maintainer has to tag it themselves. It would be good to clarify that tagging a major version only works if the maintainer chooses to support it. In my personal opinion, the risks of being broken by a bad release outweigh the benefits of always using the latest version of an action (at a specified major version). I would suggest pinning a specific version and using Dependabot to keep up-to-date instead.

Additional information

No response

@Kurt-von-Laven Kurt-von-Laven added the content label Apr 13, 2022
@github-actions github-actions bot added the triage label Apr 13, 2022
@TibbY83

This comment was marked as spam.

@ramyaparimi ramyaparimi added actions waiting for review needs SME and removed triage labels Apr 14, 2022
@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Apr 14, 2022

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Apr 21, 2022

This is a gentle bump for the docs team that this issue is waiting for technical review.

@ethomson
Copy link
Contributor

@ethomson ethomson commented Apr 22, 2022

It's correct that actions does not "understand' semantic versioning, but we're clear in our suggestions that action authors publish semantic versioned tags.

Can you suggest some language that aligns these two things? Perhaps we should iterate in a pull request. 🙏

@ramyaparimi ramyaparimi added SME reviewed help wanted and removed needs SME SME stale labels Apr 22, 2022
@ramyaparimi
Copy link
Contributor

@ramyaparimi ramyaparimi commented Apr 22, 2022

@Kurt-von-Laven Thank you for opening this issue. You or anyone else is welcome to open a PR as per the SME review .

@ramyaparimi ramyaparimi removed the waiting for review label Apr 22, 2022
@Kurt-von-Laven
Copy link
Contributor Author

@Kurt-von-Laven Kurt-von-Laven commented Apr 24, 2022

Thank you for the pointer to that doc! I found a related one previously that didn't mention authors publish all tags, but not that very clear one. I opened a PR; open to suggestions.

@Kurt-von-Laven
Copy link
Contributor Author

@Kurt-von-Laven Kurt-von-Laven commented May 10, 2022

@ramyaparimi, would you be able to reopen this issue since the associated pull request was accidentally closed?

@ramyaparimi
Copy link
Contributor

@ramyaparimi ramyaparimi commented May 11, 2022

@Kurt-von-Laven I see that this issue is already open, only the associated PR is closed. Would you like to create a new PR with a fix for this issue?

@Kurt-von-Laven Kurt-von-Laven linked a pull request May 11, 2022 that will close this issue
5 tasks
@Kurt-von-Laven
Copy link
Contributor Author

@Kurt-von-Laven Kurt-von-Laven commented May 11, 2022

Wow, clearly I needed more coffee yesterday. Thank you! I opened a new PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions content help wanted SME reviewed
Projects
None yet
5 participants
@Kurt-von-Laven @ethomson @ramyaparimi @TibbY83 and others
X Tutup