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

Build: Automated Changelog #602

Open
eddiemonge opened this issue Apr 16, 2019 · 13 comments · Fixed by sindresorhus/np#397
Open

Build: Automated Changelog #602

eddiemonge opened this issue Apr 16, 2019 · 13 comments · Fixed by sindresorhus/np#397

Comments

@eddiemonge
Copy link
Contributor

It would be nice if there was a changelog for every release so things like breaking changes, new features and bug fixes can be easily discovered. There are tools to automate this so with a one-time setup, it doesn't even have to be thought of again.

@RobinBuschmann
Copy link
Member

Hey @eddiemonge, thanks for bringing this up. Can you recommend a tool?

@eddiemonge
Copy link
Contributor Author

There are a few different ones. @sindresorhus what do you use now-a-days?

@sindresorhus
Copy link

https://github.com/sindresorhus/np creates a filled out GitHub release draft after publish now.

@RobinBuschmann
Copy link
Member

@eddiemonge @sindresorhus Thanks. I tried it out (np 1.0.0-beta.2 --tag=next --any-branch), but got Upstream branch not found; not pushing., which just skipped Pushing tags [skipped] but created a release anyway. Have I done something wrong? I'm sure, the upstream is set up properly. Is there a way to create the release draft afterwards?

@eddiemonge
Copy link
Contributor Author

Did you ever rename your remote? If not, git remote rename origin upstream

@sindresorhus
Copy link

// @itaisteinherz

@itaisteinherz
Copy link

@RobinBuschmann You need to set an upstream branch first for the push to work.
Try running $ git push --set-upstream origin master and then $ np ....

@RobinBuschmann
Copy link
Member

RobinBuschmann commented Apr 28, 2019

@itaisteinherz Thanks, but the remote branches are setup properly and I only faced the issue with a branch other than master.

Other question: Where do i find the release draft created by np?

@itaisteinherz
Copy link

itaisteinherz commented Apr 28, 2019

Thanks, but the remote branches are setup properly and I only faced the issue with a branch other than master.

@RobinBuschmann Try using the --any-branch flag I just noticed you were already using it 🧐 Also, if you bump into any other issue, feel free to open an issue over at the main repo.

Other question: We do i find the release draft created by np?

If you saved the draft you should be able to find it in the "Releases" page of the repo. Otherwise, it won't be saved (I think, at least), and you'll to write the release yourself. However, when running np, the "new release draft" page should automatically be opened and prefilled for you in your browser (which should stay there unless you closed it). Note that np doesn't save or publish the release draft for you, it only prefills it.

@itaisteinherz
Copy link

@RobinBuschmann It would be helpful if you could create a bug report for this issue, and I'll look further into it later.

@RobinBuschmann
Copy link
Member

@RobinBuschmann It would be helpful if you could create a bug report for this issue, and I'll look further into it later.

I'll do. I'm going to try a new release from a non-master branch the upcoming days. If it isn't working this time (probably I overseen something the last time), I'll come up with a bug report on https://github.com/sindresorhus/np

@itaisteinherz
Copy link

I just opened sindresorhus/np#397, which should fix this issue.

@theoludwig
Copy link
Contributor

We could provide automated changelog with clear commit message convention like conventionnal-commits.
Maybe with a tool like release-it on npm.

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.

5 participants