search

jbergstroem / hadolint-gh-action

A hadolint linter for github actions that provides code annotations (and more)
MIT License
12 stars 5 forks source link

Document versioning #28

Closed jbergstroem closed 2 years ago

jbergstroem commented 3 years ago

Mention that we aim to follow upstream semver plus our own, ultimately leading to a consistent experience for the user (being able to pin to major, min & patch)

jbergstroem commented 3 years ago

FYI: I'm currently not consistent with versioning. I make a manual call considering:

  1. (Most important) Do I break current behavior of using the action? SEMVER_MAJOR
  2. Does upstream add more features? Do I add more options? SEMVER_MINOR
  3. Do I update because of robustness, testing or improved documentation? SEMVER_PATCH

That said, I maintain a v1 branch that will never break or modify existing behavior other than adding to existing functionality (read: stay true to SEMVER_MAJOR). The same will apply to v2, but I will give no guarantees to how long I will maintain branches.

Any input on how to improve this much appreciated. I will likely move above comments to README.md soon enough.

jbergstroem commented 2 years ago

See also #88.

jbergstroem commented 2 years ago

I think by exposing versions as output as well as allowing the user to choose what they want we should be gucci.