Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CHANGELOG.md #81

Open
jtpio opened this issue Sep 29, 2023 · 1 comment
Open

Add CHANGELOG.md #81

jtpio opened this issue Sep 29, 2023 · 1 comment

Comments

@jtpio
Copy link

jtpio commented Sep 29, 2023

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/

@12rambau
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants