Improved version of source_changelog #541

j-rivero · 2021-10-27T15:22:14Z

While reading the latest changes to github product cli I just noticed that they have an script to generate changelog entries: https://github.com/cli/cli/blob/4e219a9c8f4fb2b38c2b9ff001a39729b58d61f8/script/changelog.

In trunk (hello subversion) branch in the repository they have changed it to call github API, which should probably be the way to go for us too.

Meanwhile I modified their script a little bit, I think is ready to test. A quick launch on ign-tools repository seems fine (note I disabled the check for external contributors, openrobotics emails are filtered out):

## Ignition Tools 1.x (2021-10-27)

1. Fix windows colcon build
    * [Pull request #65](https://github.com/ignitionrobotics/ign-tools/pull/65)
    * A contribution from: Steve Peters <[email protected]>

1. Fix use of Backward on macOS and add a unit test 
    * [Pull request #67](https://github.com/ignitionrobotics/ign-tools/pull/67)
    * A contribution from: Addisu Z. Taddese <[email protected]>

1. Support colcon in windows CI
    * [Pull request #66](https://github.com/ignitionrobotics/ign-tools/pull/66)
    * A contribution from: Steve Peters <[email protected]>

1. Add flag to get standard-compliant exception handling
    * [Pull request #68](https://github.com/ignitionrobotics/ign-tools/pull/68)
    * A contribution from: Addisu Z. Taddese <[email protected]>

Note: to review it, just look at the plain raw file, diff make not sense here.

Mostly copied from https://github.com/cli/cli/blob/4e219a9c8f4fb2b38c2b9ff001a39729b58d61f8/script/changelog but adapted to work with local repositories and Ignition changelogs

Signed-off-by: Jose Luis Rivero <[email protected]>

scpeters · 2021-12-23T03:10:23Z

I like the automatic tag detection, that's a definite improvement. I think it could use some more documentation about the git magic used to detect the tag, but I think it is a great idea.

One difference I noticed is how it treats merge-forward pull requests. I just tested it with sdf10 as I prepare for a 10.7.0~pre1 prerelease, and it listed two merge-forward pull requests in the changelog but didn't list the commits that were merged forward. With this branch it shows 6 new Changelog entries, while the master branch version of this script generates 40 entries. I realize that there's been recent discussion about whether to show features repeatedly in different major versions of the changelog, and I can't remember what the result of that discussion was, but I think we should consider how we want this script to handle merge commits.

scpeters · 2021-12-23T03:29:26Z

I started with this branch for gazebosim/sdformat#799 but finished by hand to include the forward-port PRs

chapulina · 2021-12-23T04:59:20Z

Oh I totally forgot about this PR!

it listed two merge-forward pull requests in the changelog but didn't list the commits that were merged forward.

Ah yeah we should have all the commits that have been merged forward

j-rivero · 2022-04-28T17:58:35Z

Oh I totally forgot about this PR!

it listed two merge-forward pull requests in the changelog but didn't list the commits that were merged forward.

Ah yeah we should have all the commits that have been merged forward

Found some time to make the changes. I tried to use the same git log approach that we currently have to reflect merges in the same way. d577f2a.

chapulina

Nice! I like it how it automatically picks up the tag.

There's still some issue with the merge commits though. If I run this on ign-gazebo right now, I only get the forward-port PR, but there are many other commits in the diff:

gazebosim/gz-sim@ignition-gazebo6_6.9.0...ign-gazebo6

chapulina · 2022-05-02T23:59:12Z

source_changelog.bash

+ printf "1. %s\n" "$pr_desc"
+ printf " * [Pull request #%s](%s/pull/%s)\n" "$pr_num" "$current_origin_remote" "$pr_num"
+ if [[ "${author_email/@openrobotics.org}" == "${author_email}" ]] && \
+ [[ "${author_email/@osrfoundation.org}" == "${author_email}" ]] && \


Not sure about excluding us, we need love too ❤️

j-rivero and others added 6 commits October 27, 2021 16:58

New version of source_changelog

8c71ffc

Mostly copied from https://github.com/cli/cli/blob/4e219a9c8f4fb2b38c2b9ff001a39729b58d61f8/script/changelog but adapted to work with local repositories and Ignition changelogs

Make the script to be able to display external contributions

c60d796

Do not display openrobotics but external contributors

b78b9a9

Signed-off-by: Jose Luis Rivero <[email protected]>

Handle git@ style of remotes

0d7055f

Exclude @osrfoundation.org emails and @noreply.github.com

aa72488

Merge branch 'master' into improve_changelog

89e9a0a

Modify the script to use current git log approach

d577f2a

j-rivero requested review from scpeters and chapulina April 28, 2022 17:58

chapulina suggested changes May 3, 2022

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improved version of source_changelog #541

Improved version of source_changelog #541

j-rivero commented Oct 27, 2021 •

edited

Loading

scpeters commented Dec 23, 2021

scpeters commented Dec 23, 2021

chapulina commented Dec 23, 2021

j-rivero commented Apr 28, 2022

chapulina left a comment

chapulina May 2, 2022

Improved version of source_changelog #541

Are you sure you want to change the base?

Improved version of source_changelog #541

Conversation

j-rivero commented Oct 27, 2021 • edited Loading

scpeters commented Dec 23, 2021

scpeters commented Dec 23, 2021

chapulina commented Dec 23, 2021

j-rivero commented Apr 28, 2022

chapulina left a comment

Choose a reason for hiding this comment

chapulina May 2, 2022

Choose a reason for hiding this comment

j-rivero commented Oct 27, 2021 •

edited

Loading