[Pulp-dev] Using commits instead of PRs in Pulp 3 release notes

Eric Helms ehelms at redhat.com
Thu Dec 13 19:43:32 UTC 2018


On Katello and Foreman, we use a template and some code from a tool we use
to do release activities to generate a formatted changelog that provides
both sets of information (Redmine issue links and commit links) broken down
by categories, see example at [1].

I'd be happy to give more information on where and how we generate this if
desired.

[1] https://github.com/Katello/katello/blob/KATELLO-3.9/CHANGELOG.md

On Thu, Dec 13, 2018 at 2:29 PM Dana Walker <dawalker at redhat.com> wrote:

> I feel like this is more accurate and comprehensive, but the initial
> summary is less readable.  I could go either way.  Others?
>
> --Dana
>
> Dana Walker
>
> Associate Software Engineer
>
> Red Hat
>
> <https://www.redhat.com>
> <https://red.ht/sig>
>
>
> On Thu, Dec 13, 2018 at 2:24 PM David Davis <daviddavis at redhat.com> wrote:
>
>> Currently in our Pulp 3 release notes[0], we link to a query of PRs with
>> the 3.0 tag merged in a certain timeframe. I feel like this is prone to
>> user errors as in cases where we might forget to add the 3.0 label to a PR
>> or get the timeframe slightly wrong because of timezones. I was thinking
>> instead we could maybe link to the list of commits between tags. Here’s an
>> example:
>>
>> https://github.com/pulp/pulp/compare/pulpcore-3.0.0b15...pulpcore-3.0.0b16
>>
>> If you click on any of these commits, there is a link to the PR by the
>> branch name so I feel like there’s no loss of information.
>>
>> Thoughts?
>>
>> [0]
>> https://docs.pulpproject.org/en/3.0/nightly/release-notes/pulpcore/3.0.x.html
>>
>> David
>> _______________________________________________
>> Pulp-dev mailing list
>> Pulp-dev at redhat.com
>> https://www.redhat.com/mailman/listinfo/pulp-dev
>>
> _______________________________________________
> Pulp-dev mailing list
> Pulp-dev at redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20181213/48c18137/attachment.htm>


More information about the Pulp-dev mailing list