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 when we issue major vs. minor vs. patch releases #3178

Open
josh-padnick opened this issue Jun 3, 2024 · 1 comment
Open

Clarify when we issue major vs. minor vs. patch releases #3178

josh-padnick opened this issue Jun 3, 2024 · 1 comment
Assignees
Labels
bug Something isn't working terragrunt

Comments

@josh-padnick
Copy link
Contributor

The community recently gave us helpful feedback that we issued a patch release that included what some users saw as a breaking change.

This prompted some internal discussions at Gruntwork about the root cause of the confusion. We believe the core issue here is that we haven't published clear guidelines on what constitutes a major vs. minor vs. patch release, and that even internally we weren't crystal clear on these nuances.

As a result, I'm proposing in this GitHub issue that we:

  1. Add clear public docs on what constitutes a major vs. minor vs. patch release
  2. Reach a conclusion internally on when issuing a 1.0 release makes sense

We'd welcome additional feedback on any guidelines you'd like to see in our release process!

@ruijarimba
Copy link

ruijarimba commented Jun 3, 2024

Add clear public docs on what constitutes a major vs. minor vs. patch release

Maybe just follow Semantic versioning?

Given a version number MAJOR.MINOR.PATCH, increment the:

  • MAJOR version when you make incompatible API changes
  • MINOR version when you add functionality in a backward compatible manner
  • PATCH version when you make backward compatible bug fixes

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working terragrunt
Projects
None yet
Development

No branches or pull requests

4 participants