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.

Sign up for GitHub

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

Update README with "Versioning" section #125

Merged
merged 1 commit into from
Nov 8, 2024
Merged

Update README with "Versioning" section #125

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,3 +86,12 @@ In the meantime you can find the full and original documentation used to run rel
## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.

## Versioning

When one or more new PRs are merged on this repository, we should cut a new release to ensure people keep using the latest version.
New releases can be published the following way:

1. Merge all opened PRs
2. Create a new tag, push it, and create an associated release on the GitHub UI
3. Create another PR that bumps the `VERSION` constant to the next release ([example PR here](https://github.com/vitessio/vitess-releaser/pull/124))