Katello 4.9.0-rc1 release process

wbclark · May 24, 2023, 8:43pm

Make this post a wiki

Roles

Release Owner: @wbclark/@iballou
Release Engineer: @odilhao

When Ready to Release

Release Owner

Request Hammer CLI Katello release from maintainers
Request Virt Who Configure release from maintainers
Request any other releases as needed from the release owners (consult the :repos: section of configs/katello/4.9.yaml)
Check for outdated deprecation warnings in the current and next release with ./tools check-deprecation-warnings configs/katello/4.9.yaml. Follow the instructions in the output of the command. Don’t forget to create any Redmine issues needed!
Update docs.theforeman.org
- Ensure [release notes](https://github.com/theforeman/foreman-documentation/blob/FOREMAN_VERSION/guides/doc-Release_Notes/katello.adoc] are correct
  - Headline features: important features with a few sentences description each
  - Upgrade notes: all important notices that users must be aware of before upgrading
  - Deprecations: features that will be removed or changed in a future version
- Using redmine_release_notes script (see README as well): ./guides/doc-Release_Notes/redmine_release_notes katello 4.9.0 > ./guides/doc-Release_Notes/topics/katello-4.9.0.adoc
- Add topics/katello-4.9.0.adoc to guides/doc-Release_Notes/master.adoc: sed '/x.y.z releases here/a include::topics/katello-4.9.0.adoc[leveloffset=+1]' master.adoc
- Make sure katello-contributors.adoc is updated
- Submit this as a PR
Open a PR (or use cherry-pick PR) against the release branch which updates lib/katello/version.rb to 4.9.0-rc1:
- git pull to make sure you have the latest changes
- sed '/VERSION/ s/".\+"/"4.9.0-rc1"/' lib/katello/version.rb
- Update/add the CHANGELOG.md file: GITHUB_ACCESS_TOKEN=<secret> ./tools changelog configs/katello/4.9.yaml
- Commit: git commit -m "Release 4.9.0-rc1"
- 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):
- Tag: git tag -s -m "Release 4.9.0-rc1" 4.9.0-rc1
- Push: git push --follow-tags (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
- Push gem: gem push katello-4.9.0-rc1.gem
Inform the delivery team that the gem is published

Once Source is Available

Release Engineer

Update release version similar to here
Update katello, katello-repos and rubygem-katello
- PROJECT=katello VERSION=4.9 ./bump_rpm_packaging
Merge packaging PR once job is green
Wait for Jenkins to build the packages (replace 4.9 with the matching Foreman version)
Download, sign, upload RPM signatures and upload RPMs
Kick off the release pipeline by calling release_pipeline

Once release is out

Release Owner

Confirm response that the build succeeded (or if necessary, do more cherry-picks and version bumps repeating the steps above)
Test the install and upgrade documentation for both the Katello server and smart proxy
Post a release announcement

ekohl · May 25, 2023, 10:16am

@wbclark I moved the post to the correct category and changed the title to be the full version. This is important because Discourse requires unique titles and we post a release process for every version, so 4.9.0-rc2 will be its own post.

I also see some things look incorrect. Mostly some steps are not needed for release candidates. Looking at the source:

github.com

theforeman/tool_belt/blob/ece8bde8ee0fbb3c3d19b6be9b5e273ed70a4eaa/procedures/katello/release.md.erb#L15-L36


      
          <% unless is_rc && full_version.end_with?('1') -%>
          - [ ] 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`
            - [ ] 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
          <% 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!
          - [ ] Update [docs.theforeman.org](https://github.com/theforeman/foreman-documentation)
            - Ensure [release notes](https://github.com/theforeman/foreman-documentation/blob/<%= foreman_version %>/guides/doc-Release_Notes/katello.adoc] are correct
              - Headline features: important features with a few sentences description each
              - Upgrade notes: all important notices that users must be aware of before upgrading
              - Deprecations: features that will be removed or changed in a future version
            - 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`
          <% unless is_rc && !full_version.end_with?('1') -%>

This file has been truncated. show original

You can see the is_rc doesn’t work. This is because you used 4.9.0.rc1 where everywhere else we use 4.9.0-rc1:

github.com

theforeman/tool_belt/blob/ece8bde8ee0fbb3c3d19b6be9b5e273ed70a4eaa/lib/tool_belt/commands/procedure.rb#L52


      
              HEREDOC
            end
          
          
  value
          end
          parameter "target-date", "Target date by which the procedure should be completed (YYYY-MM-DD)"
          parameter "owner", "The release owner's username on Discourse"
          parameter "engineer", "The release engineer's username on Discourse"
          
          
def execute
            version, extra = full_version.split('-', 2)
            major, minor, patch = version.split('.', 3)
            debian_full_version = version + (extra ? "~#{extra.downcase}" : '') + '-1'
          
          
  parsed_date = Date.parse(target_date)
          
          
  context = {
              is_rc: !extra.nil?,
              is_first_rc: extra == 'rc1',
              is_first_ga: patch == 0 && !is_rc,
              extra: extra,

I’m not sure what the best solution is here, but certainly a bug. I’d recommend somehow fixing it and regenerate the procedure.

Odilhao · May 26, 2023, 11:30pm

Release pipeline failed with:

[2023-05-26T21:54:38.928Z] TASK [install telemetry dependencies] ******************************************

[2023-05-26T21:54:38.928Z] fatal: [n27-39-246.pool.ci.centos.org]: FAILED! => {“changed”: false, “msg”: “Unable to find any of pip3.9 to use. pip needs to be installed.”}

Looks like pip3.9 is not present anymore by default on Centos8 Stream.

This will probably fix the issue Fix telemetry dependencies by Odilhao · Pull Request #1681 · theforeman/forklift · GitHub

wbclark · May 30, 2023, 7:08pm

I successfully tested the install documentation at Foreman documentation: 3.7