Fix small typos in Katello branching and release processes; add helpful clarifications #472
Conversation
procedures/foreman/release.md.erb
Outdated
| @@ -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 | |||
| - Update [foreman-contributors.adoc](https://github.com/theforeman/foreman-documentation/blob/<%= short_version %>/guides/doc-Release_Notes/topics/foreman-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. | |||
There was a problem hiding this comment.
We already have https://github.com/theforeman/theforeman.org/blob/gh-pages/scripts/committers.rb that should be used.
That repo also contains a longer .mailmap to map bad entries to normal users. To use those, it uses %aN instead. It's also based on git tags, not dates.
There was a problem hiding this comment.
Wow that's a helpful script. I'll adjust this PR in a bit to reflect this info. Thanks, Ewoud!
There was a problem hiding this comment.
@ekohl is there a way to run this script with the Katello repo? Is katello an option for --with-repo? I'd be happy to add it to the release process but unfortunately did not have enough time to figure this out.
procedures/katello/release.md.erb
Outdated
| @@ -32,7 +32,7 @@ | |||
| <% 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. | |||
There was a problem hiding this comment.
Any chance we could standardize things by using the same script or reuse as much as possible?
qcjames53
changed the title
qcjames53
force-pushed
the
master
branch
2 times, most recently
from
61c2649 to
f2d69b0
Compare
…ul clarifications
|
I kept track of every minor issue with the Katello branching and release processes and added the tweaks to this PR. I would be happy to clone the parts that make sense to the Foreman script in the not too distant future but I unfortunately don't have the time for that today. |
Fix small typos in Katello branching and release processes; add helpful clarifications.
I was routinely running into small discrepancies between the Foreman and Katello branching and release process scripts. I have made several changes to fix small issues in the processes and to clarify some sticking points:
VERSION.rc1instead ofVERSION-rc1. Katello differs from Foreman in that we use dots for release candidates../toolsare now./tools.rb.git pushcommand has been modified to allow pushes to upstream from this state.