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.

Sign up for GitHub

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

Jump to bottom

Changelog usage #1206

Closed
MrWook opened this issue Apr 4, 2022 · 7 comments
Closed

Changelog usage #1206

MrWook opened this issue Apr 4, 2022 · 7 comments

Comments

@MrWook
Copy link

MrWook commented Apr 4, 2022

I wanted to update my packages and saw that this package went to 1.0.0 recently. Unfortunately there is no direct changelog about this major release.
The tag for this release states that the CI was skipped for some reason and the changelog inside the different branches are older than 5 month. The default branch is even 9 month old.
One could go into the 1.0.0 tag and see the changelog. With the comparison feature one could even see the different between the 1.0.0 tag and older ones.

What i want to say is, it would be nice if the changelog of the default branch is up to date or/and the release page is correctly used instead of skipped.
@jvanoostveen
Copy link

I also check the release version on npm with the version mentioned in the repository to see if it might be a hijacked version (better safe than sorry). Currently there seems to be a mismatch with the published version and what is specified in the repository.

@domoritz
Copy link
Member

domoritz commented Apr 4, 2022

Changelogs are supposed to be in releases but I had a branch hook failure in https://github.com/vega/ts-json-schema-generator/runs/5630512608?check_suite_focus=true so we didn't get one. @hydrosquall do you have an idea how we can retroactively get the changelog?

@hydrosquall
Copy link
Member

@hydrosquall do you have an idea how we can retroactively get the changelog?

Yes- I think this can be used to generate the text of the changelog between arbitrary release tags.

auto changelog --from v0.20.1 --to v0.21.0

https://intuit.github.io/auto/docs/generated/changelog#examples

Once we have this, it can be pasted into the release notes when manually creating a release from https://github.com/vega/ts-json-schema-generator/releases/tag/v1.0.0

It also looks like a release wasn't created for 0.98, so we could potentially create a release for that too.

@domoritz
Copy link
Member

domoritz commented Apr 4, 2022

Can you try? I'm not able to run the command locally.

Screen Shot 2022-04-04 at 18 53 15

@hydrosquall
Copy link
Member

Sure, what I did was make a new PAT which only had access to public repos, then pasted REDACTED into the script below. I also repeated this for the 0.97.0 to .98.0 jumps.

GH_TOKEN=REDACTED yarn run auto changelog --from v0.98.0 --to v1.0.0

You then get this:

🎉 This release contains work from new contributors! 🎉

Thanks for all your work!

❤️ Hadrien Milano (@hmil)

❤️ Remi Cattiau (@loopingz)

❤️ Jason Dent (@Jason3S)

❤️ Tom Mrazauskas (@mrazauskas)

💥 Breaking Change

🚀 Enhancement

🐛 Bug Fix

  • feat!: allow JSDoc tags without explicit value (e.g. @deprecated) to default to true #1172 (@mrazauskas)

🔩 Dependency Updates

Authors: 6

@hydrosquall
Copy link
Member

Both changelogs are now up to date. I used the "create release from tag" feature in the Github UI to paste the markdown generated by the above commands into the following pages

@hydrosquall hydrosquall mentioned this issue Apr 6, 2022
Merged
@domoritz
Copy link
Member

domoritz commented Apr 6, 2022

Thank you. Seems strange to me that auto needs a token but oh well.

@domoritz domoritz closed this as completed Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jvanoostveen @domoritz @hydrosquall @MrWook