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

Autogenerate changelog off of git commits and tags #85

Merged
merged 1 commit into from
Aug 31, 2023

Conversation

grigi
Copy link
Contributor

@grigi grigi commented Aug 31, 2023

I tried 3 different libraries, and this one generates the second-best docs, but it doesn't require you to manually manage github releases. Unfortunately it's a little hacky 😶

I also only found 3 libraries in my search. There are probably more 🤷

It generates a changelog that looks like this:
image

@tobymao
Copy link
Owner

tobymao commented Aug 31, 2023

right now i release by putting a tag, can i continue to do that?

@tobymao tobymao merged commit 9bf0c1b into tobymao:master Aug 31, 2023
4 checks passed
@grigi
Copy link
Contributor Author

grigi commented Aug 31, 2023

Yes, I made it work with the minimum friction based on what you're doing.
Just tagging in the vX.Y or vX.Y.Z format will mark a version.

That's why the one that generated the nicest docs lost, as it would require a workflow change.

I mean, this is decent enough for no extra effort: https://saq-py.readthedocs.io/en/latest/changelog.html

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

Successfully merging this pull request may close these issues.

2 participants