coverallsapp / github-action

Coveralls Github Action
https://coveralls.io
MIT License
458 stars 76 forks source link

Could you release major version(s) of your GitHub action? #126

Closed jmfayard closed 1 year ago

jmfayard commented 2 years ago

Bonjour! 🇫🇷

I contribute to GitHub Actions Kotlin DSL which provides an alternative to write GitHub Actions not in YAML but in a type-safe programming language: Kotlin.

To this end we provide type-safe wrappers for currently 72 (and counting) wrapper actions. Those type-safe wrappers are generated from its action.yml which we update when it goes to a new major version, for example actions/cache@v2 to actions/cache@v3

And of course we support your action as well!

Unfortunately when an action don't have a major version, which is what GitHub recommands, we are forced to update manually for every minor version, like from appleboy/scp-action/v0.1.2 to appleboy/scp-action/v0.1.3

See our issue here

Would you consider creating a major version for your action? That would make our life easier, and the life of your users easier in general.

You can find here the recommendations from GitHub:

https://github.com/actions/toolkit/blob/main/docs/action-versioning.md (see Recommendations in particular)

jmfayard commented 2 years ago

Note: in practice this is done by pushing a tag v1 to your latest 1.x.y release

git tag -fa v1 -m "Update v1 tag"
git push origin v1 --force
stuft2 commented 2 years ago

Additionally, I would just like to point out that under the compatibility section it has this warning:

Warning: do not reference main since that is the latest code and can be carrying breaking changes of the next major version. https://github.com/actions/toolkit/blob/main/docs/action-versioning.md#compatibility

lovell commented 1 year ago

Supporting this feature might also help avoid the current problem of inconsistent tag prefixes highlighted by #94 and #100

bcomnes commented 1 year ago

Named branches also work to accomplish this, and are a bit easier to move around with git reset than tags.

mrexox commented 1 year ago

Hey! I've just pushed v1 release.