search

ros2 / ros2_documentation

ROS 2 docs repository
https://docs.ros.org/en/rolling
Creative Commons Attribution 4.0 International
530 stars 1.05k forks source link

Missing packages for Galactic Long-Form changelog #1465

Closed clalancette closed 3 years ago

clalancette commented 3 years ago

I'm currently putting together a long-form changelog for Galactic. I have a script that walks through a source directory, looking at all of the CHANGELOG.rst files. While doing that, it prints out a list of packages that don't have CHANGELOG.rst files. For each of the packages, I think it behooves us to 1) start making CHANGELOG entries for it in the future, and 2) doing some manual work now to make sure the changes for Galactic for these packages are reflected in the long-form changelog.

Packages without a changelog:

ivanpauno commented 3 years ago

doing some manual work now to make sure the changes for Galactic for these packages are reflected in the long-form changelog.

I'm not sure what's the exact output we're expecting from the manual work. I will experiment with ament_clang_format locally to see what I can do.

clalancette commented 3 years ago

I'm not sure what's the exact output we're expecting from the manual work. I will experiment with ament_clang_format locally to see what I can do.

I'm going to open a draft pull request with the automatically-generated stuff in a little bit here. We should probably fit it into that format.

ivanpauno commented 3 years ago

I'm checking locally, catkin_generate_changelog --all does a really good work of generating the complete changelog, with all items under the corresponding version subtitles.

I was thinking that we might want to do the following:

Does that sound like a good idea?

ivanpauno commented 3 years ago

e.g.: for ament_clang_format we would need to cleanup from 0.10.0 to 0.10.5 (including both 0.10.0 and 0.10.5).

To get that easily:

$ git describe --tags --contains $(git merge-base foxy master)
0.9.4

That's the newest tag in common with the foxy branch, i.e. that would be the one were we can stop cleaning up the changelog items (or just delete everything from there to the end of the file).

clalancette commented 3 years ago

Does that sound like a good idea?

Yeah, that sounds like a good idea, and it fits well into the automation that I have. I would say that we shouldn't delete everything prior to Foxy, but we should only show the changes since Foxy in the long-form changelog. I'll look at what it would take to my script to make it understand that. In the meantime, I think it is worthwhile to generate the changelogs and commit them to the repositories that are missing them, regardless.

clalancette commented 3 years ago

I'll look at what it would take to my script to make it understand that.

OK, I was able to teach my script how to parse that fairly easily. So I think we're good to go on this plan.

ivanpauno commented 3 years ago

There are a few repos that I'm not sure if they should have changelogs at all:

All those aren't maintained by the ROS 2 team (AFAIK).

clalancette commented 3 years ago

All those aren't maintained by the ROS 2 team (AFAIK).

Yeah, agreed. I'm going to strike them out on the list above so it is clear we shouldn't do anything for them.

clalancette commented 3 years ago

All right, we've done all the ones we are going to do here. So I'm going to close this out.