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

Add a change log #68

Closed
jaydenseric opened this issue Jul 8, 2017 · 6 comments
Closed

Add a change log #68

jaydenseric opened this issue Jul 8, 2017 · 6 comments

Comments

@jaydenseric
Copy link

It would be awesome if a changelog.md was added and Github releases were used to keep track of changes.

A common practice is to track changes under a next version heading at the top of changelog.md, then when ready to release:

  1. Do a commit bumping the version:
  • New version in package.json.
  • Rename the next heading in changelog.md to the new version.
  1. Create a new Github release. Follow the "Tagging suggestions" in the sidebar, and copy-paste the markdown from the change log into the description.
  2. Run npm publish.

You can see that process in action at jaydenseric/apollo-upload-client.

@fridays
Copy link
Owner

fridays commented Jul 8, 2017

Great idea. Thank you for explaining so well.

@acanimal
Copy link

It would help to work on feature branches instead always over the master branch.

@acanimal
Copy link

@fridays If you agree I can contribute with the changelog.

IMO we could use the conventional commits and automatically generate a changelog.md file with the standard-version package.

Benefits:

  • Automatically increase package.json version (similar to npm version)
  • Automatically create a tag version.
  • Generate Changelog.md file with the features, bug fixes, test, etc made since the last version

@acanimal
Copy link

Just pushed this PR #78

Is really easy to use and project would benefit from having tag releases and changelogs.

@fridays
Copy link
Owner

fridays commented Jul 17, 2017

Thank you, that looks very useful. semantic-release and zeit/release sound good too. Anyone experience with the pros and cons?

@fridays
Copy link
Owner

fridays commented Oct 7, 2017

I just made a github release using release, that was easy. Thanks again!

@fridays fridays closed this as completed Oct 7, 2017
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

3 participants