ipyvue icon indicating copy to clipboard operation
ipyvue copied to clipboard

Add `CHANGELOG.md`

Open jtpio opened this issue 1 year ago • 1 comments

Having a CHANGELOG.md file at the top-level of the repo would help users get a quick idea of the changes for each version.

Currently the latest GitHub release is 1.7.0:

image

But there is v1.10.1 tag: https://github.com/widgetti/ipyvue/releases/tag/v1.10.1

And 1.10.1 is also on PyPI: https://pypi.org/project/ipyvue/1.10.1/

jtpio avatar Sep 29 '23 17:09 jtpio

A good first step would be to synchronise all the release number together. small proposal from my side is to extract the release job from here https://github.com/widgetti/ipyvue/blob/master/.github/workflows/unit.yml and trigger it with github tags.

The main advantage (IMO) is that the github tags become the master number and all the other listen to it. cool addition is that if the modification are made with meaningful PRs (and not direct push to main) then Github can autogenerate the changelog for your: https://github.com/12rambau/sepal_ui/releases/tag/v_2.16.4

@mariobuikhuizen, @maartenbreddels if it's a wanted feature I can build a PR

12rambau avatar Nov 23 '23 15:11 12rambau