starred/humanify

Fork 0

mirror of https://github.com/jehna/humanify.git synced 2026-04-29 10:35:48 +03:00

[GH-ISSUE #31] Create official releases + changelog notes #24

New issue

Closed

opened 2026-03-03 13:52:17 +03:00 by kerem · 6 comments

kerem commented

2026-03-03 13:52:17 +03:00

Owner

Originally created by @0xdevalias on GitHub (Aug 12, 2024).
Original GitHub issue: https://github.com/jehna/humanify/issues/31

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

https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases

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 https://github.com/jehna/humanify/issues/22#issuecomment-2282876269

Originally created by @0xdevalias on GitHub (Aug 12, 2024). Original GitHub issue: https://github.com/jehna/humanify/issues/31 It would be cool if you were able to make some official github releases to help track the versions + changelog + etc: - https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases 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](https://openai.com/index/introducing-structured-outputs-in-the-api/). Please take a look and repoen if anything comes up > > _Originally posted by @jehna in https://github.com/jehna/humanify/issues/22#issuecomment-2282876269_

kerem closed this issue

2026-03-03 13:52:17 +03:00

kerem commented

2026-03-03 13:52:18 +03:00

Author

Owner

@0xdevalias commented on GitHub (Aug 12, 2024):

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

@0xdevalias commented on GitHub (Aug 12, 2024): Also, it looks like the v2 branch may have been started from scratch (first commit: https://github.com/jehna/humanify/commit/e9770a63461835aac2e23fe0b0761610046cc634), rather than continuing on from the historical branch (https://github.com/jehna/humanify/tree/v1). Why was that?

kerem commented

2026-03-03 13:52:18 +03:00

Author

Owner

@jehna commented on GitHub (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: github.com/jehna/humanify@e9770a6346), 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 commented on GitHub (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: https://github.com/jehna/humanify/commit/e9770a63461835aac2e23fe0b0761610046cc634), 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 😬

kerem commented

2026-03-03 13:52:18 +03:00

Author

Owner

@jehna commented on GitHub (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 commented on GitHub (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

kerem commented

2026-03-03 13:52:18 +03:00

Author

Owner

@jehna commented on GitHub (Aug 12, 2024):

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

@jehna commented on GitHub (Aug 12, 2024): Here's the docs for `gh release create --generate-notes`: https://cli.github.com/manual/gh_release_create

kerem commented

2026-03-03 13:52:18 +03:00

Author

Owner

@jehna commented on GitHub (Aug 15, 2024):

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

@jehna commented on GitHub (Aug 15, 2024): Should work now, creates this kind of autogenerated release notes: https://github.com/jehna/humanify/releases/tag/v2.1.0

kerem commented

2026-03-03 13:52:18 +03:00

Author

Owner

@0xdevalias commented on GitHub (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 https://github.com/jehna/humanify/pull/42#discussion_r1719339469

@0xdevalias commented on GitHub (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 https://github.com/jehna/humanify/pull/42#discussion_r1719339469_