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.

Sign up for GitHub

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

Jump to bottom

Update RELEASE.md for lerna-changelog & travis deploy #200

Merged
merged 2 commits into from Feb 1, 2018
Merged

Update RELEASE.md for lerna-changelog & travis deploy #200

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
221a2d1
Update RELEASE.md for lerna-changelog & travis deploy
kategengler Feb 1, 2018
29e8b50
Remove bit about creating github releases, that hasn't been done for a
kategengler Feb 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 8 additions & 16 deletions RELEASE.md
View file
Open in desktop
Expand Up @@ -4,15 +4,15 @@ The following is the release process you should follow to publish a new version

## Update The Changelog

First, we need to update the `CHANGELOG.md` file for the project. We do this via the [GitHub Changelog Generator](https://github.com/skywinder/github-changelog-generator/), using the following command:
First, we need to update the `CHANGELOG.md` file for the project. We do this via the [lerna-changelog](https://github.com/lerna/lerna-changelog). This requires all PRs to be labeled appropriately. Use the following command to generate the changelog from the most recent tag:

```bash
github_changelog_generator --future-release vx.x.x
yarn changelog
```

Where you replace the `x.x.x` with the appropriate version you are publishing.
Copy the output into `CHANGELOG.md`, where you replace the `Unreleased` with the appropriate version you are publishing.

_Note: Ensure you set up a [GitHub Token](https://github.com/skywinder/github-changelog-generator/#github-token) when using the changelog generator, or else it will not work properly._
_Note: Ensure you set up a GitHub Token when using the changelog generator, or else it will not work properly._
Copy link
Member

Choose a reason for hiding this comment

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

I haven't found this to be an issue (generally speaking)

Copy link
Member Author

Choose a reason for hiding this comment

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

@rwjblue You probably already have a token in GITHUB_AUTH environment variable, though?


Review the changes and then commit them with a message like:

Expand All @@ -28,18 +28,10 @@ Next, we bump the version of the addon and tag it. You can do this by using the
npm version x.x.x
```

That should bump the version in `package.json`, commit it, and then tag it.
That should bump the version in `package.json`, commit it, and then tag it. Be sure to push the commit and tag.

Next, push the version bump and the changelog changes to the repository.

## Publish The Release

Once the changes have been pushed, run:

```bash
npm publish
```

To actually publish the new release.
## Publish
Next, push the version bump and the changelog changes to the repository. Upon successful build of the tag, Travis CI will publish to `npm`.

Finally, update the [GitHub Releases page](https://github.com/ember-cli/ember-cli-qunit/releases) with a new release; using the changelog info as the release notes.