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 automated release setup. #170

Merged
merged 1 commit into from Aug 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Empty file added CHANGELOG.md
Empty file.
62 changes: 62 additions & 0 deletions RELEASE.md
@@ -0,0 +1,62 @@
# Release

Releases are mostly automated using
[release-it](https://github.com/release-it/release-it/) and
[lerna-changelog](https://github.com/lerna/lerna-changelog/).


## Preparation

Since the majority of the actual release process is automated, the primary
remaining task prior to releasing is confirming that all pull requests that
have been merged since the last release have been labeled with the appropriate
`lerna-changelog` labels and the titles have been updated to ensure they
represent something that would make sense to our users. Some great information
on why this is important can be found at
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
guiding principle here is that changelogs are for humans, not machines.

When reviewing merged PR's the labels to be used are:

* breaking - Used when the PR is considered a breaking change.
* enhancement - Used when the PR adds a new feature or enhancement.
* bug - Used when the PR fixes a bug included in a previous release.
* documentation - Used when the PR adds or updates documentation.
* internal - Used for internal changes that still require a mention in the
changelog/release notes.


## Release

Once the prep work is completed, the actual release is straight forward:

* First, ensure that you have installed your projects dependencies:

```
yarn install
```

* Second, ensure that you have obtained a
[GitHub personal access token][generate-token] with the `repo` scope (no
other permissions are needed). Make sure the token is available as the
`GITHUB_AUTH` environment variable.

For instance:

```bash
export GITHUB_AUTH=abc123def456
```

[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable

* And last (but not least 😁) do your release.

```
npx release-it
```

[release-it](https://github.com/release-it/release-it/) manages the actual
release process. It will prompt you to to choose the version number after which
you will have the chance to hand tweak the changelog to be used (for the
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
pushing the tag and commits, etc.
26 changes: 23 additions & 3 deletions package.json
Expand Up @@ -2,15 +2,15 @@
"name": "ember-source-channel-url",
"version": "2.0.1",
"description": "Determine the URL to a given Ember channels (beta, canary, etc) latest tarball.",
"repository": "git@github.com:rwjblue/ember-source-channel-url.git",
"license": "MIT",
"author": "Robert Jackson <me@rwjblue.com>",
"main": "src/index.js",
"bin": "./bin/ember-source-channel-url",
"files": [
"bin/",
"src/"
],
"main": "src/index.js",
"bin": "./bin/ember-source-channel-url",
"repository": "git@github.com:rwjblue/ember-source-channel-url.git",
"scripts": {
"lint:js": "eslint .",
"test": "qunit tests/**/*-test.js"
Expand All @@ -28,10 +28,30 @@
"prettier": "^1.19.1",
"qunit": "~2.9.3",
"qunit-eslint": "^2.0.0",
"release-it": "^13.6.5",
"release-it-lerna-changelog": "^2.3.0",
"rsvp": "^4.8.5",
"tmp": "^0.1.0"
},
"engines": {
"node": "10.* || 12.* || >= 14"
},
"publishConfig": {
"registry": "https://registry.npmjs.org"
},
"release-it": {
"plugins": {
"release-it-lerna-changelog": {
"infile": "CHANGELOG.md",
"launchEditor": true
}
},
"git": {
"tagName": "v${version}"
},
"github": {
"release": true,
"tokenRef": "GITHUB_AUTH"
}
}
}