search

machines-in-motion / real_time_tools

BSD 3-Clause "New" or "Revised" License
9 stars 6 forks source link

Bump version to 3.0.0 and add changelog #35

Closed luator closed 2 years ago

luator commented 2 years ago

Description

Bump version to 3.0.0 and add a changelog (following the format suggested by https://keepachangelog.com/en/1.0.0/).

In preparation for the upcoming Real Robot Challenge 2022, I'm making versioned releases of our packages and use the occasion to add proper changelog files.

@jviereck @MaximilienNaveau: It would be great if you could give a brief summary of what was changed in #31 (just "Changes in UsbStream" is not very useful^^).

MaximilienNaveau commented 2 years ago

@jviereck @MaximilienNaveau: It would be great if you could give a brief summary of what was changed in #31 (just "Changes in UsbStream" is not very useful^^).

I believe the message should be:

"Add safety checks during the reading of serial port (usb) messages"

MaximilienNaveau commented 2 years ago

The CI blocks?

MaximilienNaveau commented 2 years ago

The compilation of the documentation is a huge mess... I am sorry for this I don't have the time to maintain it properly I believe the documentation is using packages that are not maintained properly and hence fails miserably in the build farm...

luator commented 2 years ago

I believe the message should be:

"Add safety checks during the reading of serial port (usb) messages"

Thanks, I updated the changelog.

I ran into some issue with mistune as well some time ago. Fixing the version to <2.0.0 solved it for me.

I also would like to work more on the documentation build (ideally to get rid of the redundant cmake implementation) but likewise didn't have enough time for it yet :/.

MaximilienNaveau commented 2 years ago

I think I fixed the CI, I found the same link you sent me aha

luator commented 2 years ago

Is it okay if I merge?

MaximilienNaveau commented 2 years ago

Go ahead