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

chore: address retroactive stability increases in versioning doc #52

Merged
merged 1 commit into from
Nov 5, 2021

Conversation

cmars
Copy link
Contributor

@cmars cmars commented Nov 4, 2021

Amend the versioning standard to prohibit retroactive stability
increases on existing versions, with an example of why it causes
problems.

@cmars cmars requested a review from a team as a code owner November 4, 2021 20:30
docs/version.md Outdated
@@ -67,13 +63,25 @@ In increasing order of stability, from least to most stable, these are:
- During its availability, it must not be revised with incompatible and breaking changes.
- It may be revised with backwards-compatible, additive changes.

### Increasing stability of a release
### Increasing stability of a resource over time
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another way for us to frame this: promotion of a route requires a new route + the old one to continue to be routed.

Do we have an issue to track implementing a rule?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the framing, added #53. PTAL

Amend the versioning standard to prohibit retroactive stability
increases on existing versions, with an example of why it causes
problems.
@cmars cmars force-pushed the chore/versioning-doc-stability-changes branch from b4a03f2 to 50371f0 Compare November 4, 2021 21:42
Copy link
Contributor

@genslein genslein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch!

@cmars cmars merged commit d3c1096 into main Nov 5, 2021
@cmars cmars deleted the chore/versioning-doc-stability-changes branch November 5, 2021 14:40
@snyksec
Copy link

snyksec commented Nov 9, 2021

🎉 This PR is included in version 0.3.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants