Skip to content

Commit

Permalink
Fix small typos in Katello branching and release processes; add helpf…
Browse files Browse the repository at this point in the history
…ul clarifications
  • Loading branch information
qcjames53 committed Mar 4, 2025
1 parent ca9de62 commit 2b92672
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion procedures/foreman/release.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Note: If for some reason there was an issue with the tarballs that required uplo
<% if is_first_rc || (!is_rc && !is_first_ga) -%>
- Add `topics/foreman-<%= version %>.adoc` to `guides/doc-Release_Notes/master.adoc`: `sed -i '/x.y.z releases here/a include::topics/foreman-<%= version %>.adoc[leveloffset=+1]' guides/doc-Release_Notes/master.adoc`
<% end -%>
- Make sure [foreman-contributors.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= short_version %>/guides/doc-Release_Notes/topics/foreman-contributors.adoc) is updated
- Make sure [foreman-contributors.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= short_version %>/guides/doc-Release_Notes/topics/foreman-contributors.adoc) is updated.
- Make sure headline features, upgrade warnings and deprecations are in sync with the website
- Submit this as a PR
<% if is_first_rc -%>
Expand Down
2 changes: 1 addition & 1 deletion procedures/katello/branch.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
- [ ] Set GitHub Actions to use the new branch: `sed -i '/foreman_version/ s/develop/<%= foreman_version %>-stable/' .github/workflows/*.yml`
- [ ] Generate and post the release procedure, if not already posted:
- [ ] Use <%= rel_eng_script('procedure_release') %>: `PROJECT=katello VERSION=<%= release %> ./procedure_release "<%= target_date %>" "<%= owner %>" "<%= engineer %>"`
- [ ] Post the output in [Development/Releases](https://community.theforeman.org/c/development/releases/20) using `Katello <%= release %>.0-rc1 release process`
- [ ] Post the output in [Development/Releases](https://community.theforeman.org/c/development/releases/20) using `Katello <%= release %>.0.rc1 release process`
- [ ] Clone https://github.com/theforeman/apidocs and follow the Katello README section to update the API documentation.
- [ ] Prepare "Katello Next" and future redmine versions
- [ ] Rename the "Katello Next" release to Katello <%= develop %>.0
Expand Down
12 changes: 6 additions & 6 deletions procedures/katello/release.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
- [ ] Do Cherry-picks: Clone [tool_belt](https://github.com/theforeman/tool_belt)
- [ ] If any minor versions of Katello have been added to Redmine since the last cherry-pick, make sure to include them in `prior_releases` in configs/katello/<%= short_version %>.yaml
- [ ] Run `./tools.rb setup-environment configs/katello/<%= short_version %>.yaml`
- [ ] Run `GITHUB_ACCESS_TOKEN=<secret> ./tools.rb cherry-picks --version <%= full_version %> configs/katello/<%= short_version %>.yaml`
- [ ] Run `GITHUB_ACCESS_TOKEN=<secret> PROJECT=katello VERSION=<%= short_version %> ./tools.rb cherry-picks configs/katello/<%= short_version %>.yaml`
- [ ] Open a PR in Katello release branch. Make sure the PR name starts with [CP] to prevent our automations from adding it to Redmine issues.
- [ ] Using `git cherry-pick -x` as needed, verify tickets in the cherry_picks_<%= full_version %> file are accounted for, or additionally cherry-pick them. Recommended: Do this in tool_belt's checkout of Katello, in `repos/katello/<%= full_version %>/katello`. This way when you run cherry-picks again, tool_belt will be aware of any picks already completed.
- [ ] For any cherry-picks that are not needed (including Redmine trackers) you can add them to the `:ignores:` section of `tool_belt` in `configs/katello/<%= short_version %>.yaml`
<% end -%>
<% unless is_rc -%>
- [ ] Change Redmine version <%= full_version %> state to Closed using <%= rel_eng_script('close_redmine_version') %>: `PROJECT=katello VERSION=<%= short_version %> ./close_redmine_version` and enter your Redmine API Key when prompted.
<% end -%>
- [ ] Check for outdated deprecation warnings in the current and next release with `./tools check-deprecation-warnings configs/katello/<%= short_version %>.yaml`. Follow the instructions in the output of the command. Don't forget to create any Redmine issues needed!
- [ ] Check for outdated deprecation warnings in the current and next release with `./tools.rb check-deprecation-warnings configs/katello/<%= short_version %>.yaml`. Follow the instructions in the output of the command. Don't forget to create any Redmine issues needed!
- [ ] Update the `<%= foreman_version %>` branch in [foreman-documentation](https://github.com/theforeman/foreman-documentation)
- Ensure [release notes](https://github.com/theforeman/foreman-documentation/blob/<%= foreman_version %>/guides/doc-Release_Notes/topics/katello.adoc) are correct
- Headline features: important features with a few sentences description each
Expand All @@ -32,24 +32,24 @@
<% unless is_rc && !full_version.end_with?('1') -%>
- Add `topics/katello-<%= version %>.adoc` to `guides/doc-Release_Notes/master.adoc`: `sed '/x.y.z releases here/a include::topics/katello-<%= version %>.adoc[leveloffset=+1]' master.adoc`
<% end -%>
- Make sure [katello-contributors.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= foreman_version %>/guides/doc-Release_Notes/topics/katello-contributors.adoc) is updated
- Update [katello-contributors.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= foreman_version %>/guides/doc-Release_Notes/topics/katello-contributors.adoc) with the list of contributors using `git log --since="<YYYY-MM-DD of previous major release branching>" --format="%an" | sort | uniq`. Manually clean up any erroneous entries.
- Submit this as a PR

- [ ] 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 --version <%= full_version %> configs/katello/<%= short_version %>.yaml`
- [ ] Update/add the CHANGELOG.md file: `GITHUB_ACCESS_TOKEN=<secret> PROJECT=katello VERSION=<%= short_version %> ./tools.rb 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.)
- [ ] Once the PR is merged, perform the following in the Katello release branch (the real one, not your fork):
- [ ] Create upstream remote: `git remote add upstream https://github.com/Katello/katello.git`
- [ ] Fetch upstream remote: `git fetch upstream`
- [ ] Checkout upstream release branch: `git checkout upstream/KATELLO-<%= short_version %>`
- [ ] Tag: `git tag -s -m "Release <%= full_version %>" <%= full_version %>`
- [ ] Push: `git push --follow-tags` (Must be pushed directly to the release branch, as pull request merges will not preserve tags.)
- [ ] Push: `git push --follow-tags upstream HEAD:KATELLO-<%= short_version %>` (Must be pushed directly to the release branch, as pull request merges will not preserve tags.)
- [ ] Generate .mo translation files: `make -C locale all-mo` in the katello directory
- [ ] Generate source gem: `gem build katello.gemspec`
- [ ] Ensure you have a working login and password at rubygems.org
- [ ] Ensure you have login, password, and two factor authentication set up for rubygems.org
- [ ] Push gem: `gem push katello-<%= full_version %>.gem`
- [ ] Inform the delivery team that the gem is published

Expand Down

0 comments on commit 2b92672

Please sign in to comment.