-
Notifications
You must be signed in to change notification settings - Fork 337
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
docs(*) release process #341
Conversation
RELEASE.md
Outdated
To release new version of Kuma follow the steps: | ||
|
||
1. Create a CHANGELOG.md. | ||
2. Create PR to [kuma.io website repository](https://github.com/Kong/kuma-website) making sure that all new features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think that documenting all new features is part of the release process
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be done when developing new features, but release it's a good time (since we modify CHANGELOG.md
) to double-check that we've done it
RELEASE.md
Outdated
To release new version of Kuma follow the steps: | ||
|
||
1. Create a CHANGELOG.md. | ||
2. Create PR to [kuma.io website repository](https://github.com/Kong/kuma-website) making sure that all new features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From this description it looks like that you create a PR for https://kuma.io in order to document new features.
While, in fact, the goal is to add download links and installation guide for the new version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rephrased so it's clear that this is for links. Added new step for double-checking that features are documented
bb4901a
to
f883fef
Compare
2. Double-check with changelog that all new features are documented on kuma.io website. | ||
3. Create PR to [kuma.io website repository](https://github.com/Kong/kuma-website) with new download links and the new version. | ||
4. Create a new git tag. | ||
5. Push git tag. This will trigger the release job on CI. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally the release job CI should do step 7 for us ( double check that it works with demo app ). Not necessary at this time but a good CI/CD backlog item to keep in mind
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is correct, we need better integration/e2e tests.
Summary
Describe release process.