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

Katello release process & release notes #248

Open
ekohl opened this issue Aug 9, 2023 · 0 comments
Open

Katello release process & release notes #248

ekohl opened this issue Aug 9, 2023 · 0 comments

Comments

@ekohl
Copy link
Member

ekohl commented Aug 9, 2023

Right now the Katello release process instructs to create release notes:

- Using [redmine_release_notes](https://github.com/theforeman/foreman-documentation/blob/<%= foreman_version %>/guides/doc-Release_Notes/redmine_release_notes) script (see [README](https://github.com/theforeman/foreman-documentation/blob/<%= short_version %>/guides/doc-Release_Notes/README.md) as well): `./guides/doc-Release_Notes/redmine_release_notes katello <%= version %> > ./guides/doc-Release_Notes/topics/katello-<%= version %>.adoc`

Then it creates a PR with cherry picks:

- [ ] Open a PR (or use cherry-pick PR) against the release branch which updates `lib/katello/version.rb` to <%= full_version %>:
- [ ] `git pull` to make sure you have the latest changes
- [ ] `sed '/VERSION/ s/".\+"/"<%= full_version %>"/' lib/katello/version.rb`
- [ ] Update/add the CHANGELOG.md file: `GITHUB_ACCESS_TOKEN=<secret> ./tools changelog configs/katello/<%= short_version %>.yaml`
- [ ] Commit: `git commit -m "Release <%= full_version %>"`
- [ ] Ensure that the commit above is the _last_ commit and there are no commits after it. This is the commit that will get tagged. (Rearrange commits with `git rebase -i` if needed.)

This means the Fixed in releases field in Redmine can't be correct at the time the release notes are made.

In Foreman this is not a problem because the cherry picks happen before and the release bit only bumps the version.

One solution is to move the release notes creation but another is to further align both processes. Katello could split the creation of cherry picks and the actual release in two.

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

No branches or pull requests

1 participant