search

pacti-org / pacti

A package for compositional system analysis and design
https://www.pacti.org
BSD 3-Clause "New" or "Revised" License
19 stars 5 forks source link

How to maintain changelog #237

Closed iincer closed 1 year ago

iincer commented 1 year ago

We need to figure out how to maintain a changelog.

Task

Develop a methodology for maintaining a changelog. We have a command called make changelog. What does it do? What data do we have to provide it? How can it know automatically what changes are being made to a version?

ayush9pandey commented 1 year ago

Fixed the syntax of generating changelog in the changelog branch.

Package releases are the data that we provide to make changelog so that it can generate what changed. To test this, I created a 0.0.1-alpha release. Might need to create a second release 0.0.1-beta to test whether the changelog functionality works as expected.

ayush9pandey commented 1 year ago

The changelog branch is correctly generating the URLs now and updating the CHANGELOG.md file on running make changelog. We may need to add a changelog manually for this release, but I wonder how does the git_changelog package generate changelog text from the git changelog. Will look into that next..