fridays / next-routes

Universal dynamic routes for Next.js
MIT License
2.47k stars 230 forks source link

Add a change log #68

Closed jaydenseric closed 6 years ago

jaydenseric commented 7 years ago

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.
  2. Create a new Github release. Follow the "Tagging suggestions" in the sidebar, and copy-paste the markdown from the change log into the description.
  3. Run npm publish.

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

fridays commented 7 years ago

Great idea. Thank you for explaining so well.

acanimal commented 7 years ago

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

acanimal commented 7 years ago

@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:

acanimal commented 7 years ago

Just pushed this PR https://github.com/fridays/next-routes/pull/78

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

fridays commented 7 years ago

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

fridays commented 6 years ago

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