Update changelog for 0.8.0 and add Lerna Changelog #1141

Merged
merged 2 commits into from Dec 3, 2016

Projects

None yet

4 participants

@fson
Collaborator
fson commented Dec 3, 2016

Lerna Changelog allows us to generate a scaffold for the changelog, a list of changes with all the PR and contributor links in place, from labeled GitHub pull requests.

I added the following labels (inspired by Babel's change log which is also made with Lerna Changelog).

  • tag: new feature: 🚀 New Feature – Features added in this release.
  • tag: breaking change: 💥 Breaking Change – Breaking changes should be accompanied with a migration guide for users in the change log.
  • tag: bug fix: 🐛 Bug Fix
  • tag: enhancement: 💅 Enhancement – Changes to existing features.
  • tag: documentation: 📝 Documentation – Contributions to docs can also be credited in the change log now.
  • tag: internal: 🏠 Internal – Any internal house keeping / refactoring / infra change that doesn't affect the public interface of the tools.

Any merged pull request should be tagged with one these labels so it's picked up for change log in the next release. Lerna Changelog also detects which packages were affected by each change and shows this in the log.

This saves a lot of time when doing releases because a large part of the manual work is done automatically. It's still very important to write good descriptions of the changes in the change log, because it's a document meant to be read by humans, not just a list of commits. But having the bulk of the log generated by this tool gives us more time to focus on authoring these descriptions.

@fson
Collaborator
fson commented Dec 3, 2016 edited

@gaearon Could you review that the new format is OK? I can then cut the release.

CHANGELOG.md
+* `react-scripts`
+ * [#944](https://github.com/facebookincubator/create-react-app/pull/944) Crash the build during CI whenever linter warnings are encountered. ([@excitement-engineer](https://github.com/excitement-engineer))
+
+ Linter warnings and errors will now be checked for during the build when it's run in a continous integration server (the `CI` environment variable is set) and the build will fail if issues are found. See [Continuous Integration](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#continuous-integration) for more.
@existentialism
existentialism Dec 3, 2016 Contributor

Nit: continous => continuous

And maybe:

Linter warnings and errors are now checked during a continuous integration build (set by the CI environment variable) and will fail if any issues are found.

@fson
fson Dec 3, 2016 Collaborator

Thanks, updated.

@gaearon
Contributor
gaearon commented Dec 3, 2016

LGTM

@fson fson merged commit e167e45 into facebookincubator:master Dec 3, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@fson fson deleted the fson:lerna-changelog branch Dec 3, 2016
@markgardner markgardner added a commit to markgardner/create-react-app that referenced this pull request Dec 5, 2016
@fson @markgardner fson + markgardner Update changelog for 0.8.0 and add Lerna Changelog (#1141) 1664240
@EnoahNetzach EnoahNetzach added a commit to EnoahNetzach/create-react-app that referenced this pull request Dec 7, 2016
@fson @EnoahNetzach fson + EnoahNetzach Update changelog for 0.8.0 and add Lerna Changelog (#1141) 243d348
@stephenjwatkins stephenjwatkins added a commit to stephenjwatkins/create-react-app that referenced this pull request Jan 4, 2017
@fson @stephenjwatkins fson + stephenjwatkins Update changelog for 0.8.0 and add Lerna Changelog (#1141) 86f95b3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment