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

Create official releases + changelog notes #31

Closed
0xdevalias opened this issue Aug 12, 2024 · 6 comments
Closed

Create official releases + changelog notes #31

0xdevalias opened this issue Aug 12, 2024 · 6 comments

Comments

@0xdevalias
Copy link

0xdevalias commented Aug 12, 2024

It would be cool if you were able to make some official github releases to help track the versions + changelog + etc:

I only found out that the 2.0 version came out by accident:

This should now be fixed in v2 since there's the long awaited JSON mode with the new structured outputs. Please take a look and repoen if anything comes up

Originally posted by @jehna in #22 (comment)

@0xdevalias
Copy link
Author

0xdevalias commented Aug 12, 2024

Also, it looks like the v2 branch may have been started from scratch (first commit: e9770a6), rather than continuing on from the historical branch (https://github.com/jehna/humanify/tree/v1). Why was that?

@jehna
Copy link
Owner

jehna commented Aug 12, 2024

It would be cool if you were able to make some official github releases to help track the versions + changelog + etc

Yes, let's do this for new versions! I think I can generate a changelog and versioning automatically while doing a new release to npm.

Also, it looks like the v2 branch may have been started from scratch (first commit: e9770a6), rather than continuing on from the historical branch (https://github.com/jehna/humanify/tree/v1). Why was that?

Yes, v2 was a complete rewrite from scratch, so I started with an orphan branch. Probably should have rebased on top of a clean-wiped v1 to ensure git pull would have worked for others that had cloned the repo, I can imagine it caused quite some conflicts. Sorry about that 😬

@jehna
Copy link
Owner

jehna commented Aug 12, 2024

I've used this in some other projects, could become handy here too:
https://docs.github.com/en/repositories/releasing-projects-on-github/automatically-generated-release-notes

@jehna
Copy link
Owner

jehna commented Aug 12, 2024

Here's the docs for gh release create --generate-notes:
https://cli.github.com/manual/gh_release_create

@jehna
Copy link
Owner

jehna commented Aug 15, 2024

Should work now, creates this kind of autogenerated release notes:
https://github.com/jehna/humanify/releases/tag/v2.1.0

@jehna jehna closed this as completed Aug 15, 2024
@0xdevalias
Copy link
Author

0xdevalias commented Aug 16, 2024

Should work now

@jehna Looks good! Any plans to create retroactive releases for previous versions? (it looks like they're all tagged)

I also notice that it doesn't look like releases are shown on the right hand column of the main page of the repo.. so you may need to tick that box in the repo settings too.

One other note/question:

I get that you might want to suppress dependabot as 'noise'; but I also wonder if knowing what libraries were updated might be useful? At least for main dependencies (devDependencies probably less so)

Originally posted by @0xdevalias in #42 (comment)

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