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

Provide changelog ? #126

Closed
popod opened this issue Jul 17, 2021 · 6 comments · Fixed by #169
Closed

Provide changelog ? #126

popod opened this issue Jul 17, 2021 · 6 comments · Fixed by #169

Comments

@popod
Copy link

popod commented Jul 17, 2021

Hi, could you please provide changelog ?

A list of changes for each releases ?

Thank you

@Trott
Copy link
Collaborator

Trott commented Jul 17, 2021

@simov If you want to automate releases with semantic-release, we can set up release-notes-generator to create a change log automatically. This is what I use for all my modules. The resulting change log files won't win any awards, but they are sufficient and they don't require any extra effort other than making sure we use conventional commits.

If that sounds like a good idea, I can do the configuration, but you'll need to add an npm publishing token as a GitHub secret to this repo (or I can do that if you give me admin access to the repo).

@simov
Copy link
Owner

simov commented Jul 18, 2021

@Trott sounds good. However, can we generate the changelog manually before every release and continue relying on us to provide the correct semver and to publish the module? I don't think GitHub supports that level of access for collaborators on personal repos, and I'm just thinking of a quick way to get that changelog generated.

@coreyward
Copy link

coreyward commented Aug 24, 2022

Bump on this. When I see something like this in my yarn outdated output, the first thing I do is go look for either Github Releases documenting the changes or a CHANGELOG file so I know whether or not there are breaking changes. I use slugify in libraries for other people, so out of respect for their time, I have to understand the impact before upgrading.

Screen Shot 2022-08-24 at 11 35 06 AM

@simov simov mentioned this issue Aug 25, 2022
@simov
Copy link
Owner

simov commented Aug 25, 2022

@coreyward
Copy link

@simov Heck yeah, super helpful. Can you merge that into main/master?

@simov
Copy link
Owner

simov commented Aug 25, 2022

Here it is https://github.com/simov/slugify/blob/master/CHANGELOG.md

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 a pull request may close this issue.

4 participants