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

Update changelog for 0.8.0 and add Lerna Changelog #1141

Merged
merged 2 commits into from
Dec 3, 2016

Conversation

fson
Copy link
Contributor

@fson 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
Copy link
Contributor Author

fson commented Dec 3, 2016

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

* `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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, updated.

@gaearon
Copy link
Contributor

gaearon commented Dec 3, 2016

LGTM

@fson fson merged commit e167e45 into facebook:master Dec 3, 2016
@fson fson deleted the lerna-changelog branch December 3, 2016 15:53
alexdriaguine pushed a commit to alexdriaguine/create-react-app that referenced this pull request Jan 23, 2017
randycoulman pushed a commit to CodingZeal/create-react-app that referenced this pull request May 8, 2017
@lock lock bot locked and limited conversation to collaborators Jan 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants