Skip to content

Commit 19e28bc

Browse files
committed
chore: Adding release-it
1 parent 055000f commit 19e28bc

4 files changed

Lines changed: 1667 additions & 81 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Changelog

RELEASE.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Release Process
2+
3+
Releases are mostly automated using
4+
[release-it](https://github.com/release-it/release-it/) and
5+
[lerna-changelog](https://github.com/lerna/lerna-changelog/).
6+
7+
## Preparation
8+
9+
Since the majority of the actual release process is automated, the primary
10+
remaining task prior to releasing is confirming that all pull requests that
11+
have been merged since the last release have been labeled with the appropriate
12+
`lerna-changelog` labels and the titles have been updated to ensure they
13+
represent something that would make sense to our users. Some great information
14+
on why this is important can be found at
15+
[keepachangelog.com](https://keepachangelog.com/en/1.0.0/), but the overall
16+
guiding principle here is that changelogs are for humans, not machines.
17+
18+
When reviewing merged PR's the labels to be used are:
19+
20+
* breaking - Used when the PR is considered a breaking change.
21+
* enhancement - Used when the PR adds a new feature or enhancement.
22+
* bug - Used when the PR fixes a bug included in a previous release.
23+
* documentation - Used when the PR adds or updates documentation.
24+
* internal - Used for internal changes that still require a mention in the
25+
changelog/release notes.
26+
27+
## Release
28+
29+
Once the prep work is completed, the actual release is straight forward:
30+
31+
* First, ensure that you have installed your projects dependencies:
32+
33+
```sh
34+
yarn install
35+
```
36+
37+
* Second, ensure that you have obtained a
38+
[GitHub personal access token][generate-token] with the `repo` scope (no
39+
other permissions are needed). Make sure the token is available as the
40+
`GITHUB_AUTH` environment variable.
41+
42+
For instance:
43+
44+
```bash
45+
export GITHUB_AUTH=abc123def456
46+
```
47+
48+
[generate-token]: https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable
49+
50+
* And last (but not least 😁) do your release.
51+
52+
```sh
53+
npx release-it
54+
```
55+
56+
[release-it](https://github.com/release-it/release-it/) manages the actual
57+
release process. It will prompt you to to choose the version number after which
58+
you will have the chance to hand tweak the changelog to be used (for the
59+
`CHANGELOG.md` and GitHub release), then `release-it` continues on to tagging,
60+
pushing the tag and commits, etc.

package.json

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
11
{
22
"name": "ember-qunit-5-codemod",
33
"version": "0.1.0",
4+
"keywords": [
5+
"codemod-cli"
6+
],
7+
"repository": {
8+
"type": "git",
9+
"url": "https://github.com/ember-codemods/ember-qunit-5-codemod.git"
10+
},
11+
"bin": "./bin/cli.js",
412
"scripts": {
513
"lint": "eslint --cache .",
614
"test": "codemod-cli test",
715
"test:coverage": "codemod-cli test --coverage",
816
"update-docs": "codemod-cli update-docs",
917
"coveralls": "cat ./coverage/lcov.info | node node_modules/.bin/coveralls"
1018
},
11-
"bin": "./bin/cli.js",
12-
"keywords": [
13-
"codemod-cli"
14-
],
19+
"jest": {
20+
"testEnvironment": "node"
21+
},
1522
"dependencies": {
1623
"codemod-cli": "^3.1.1"
1724
},
@@ -22,12 +29,29 @@
2229
"eslint-plugin-node": "^11.1.0",
2330
"eslint-plugin-prettier": "^3.3.1",
2431
"jest": "^26.6.3",
25-
"prettier": "^2.2.1"
32+
"prettier": "^2.2.1",
33+
"release-it": "^14.2.1",
34+
"release-it-lerna-changelog": "^3.1.0"
2635
},
2736
"engines": {
2837
"node": "10.* || 12.* || >= 14"
2938
},
30-
"jest": {
31-
"testEnvironment": "node"
39+
"publishConfig": {
40+
"registry": "https://registry.npmjs.org"
41+
},
42+
"release-it": {
43+
"plugins": {
44+
"release-it-lerna-changelog": {
45+
"infile": "CHANGELOG.md",
46+
"launchEditor": true
47+
}
48+
},
49+
"git": {
50+
"tagName": "v${version}"
51+
},
52+
"github": {
53+
"release": true,
54+
"tokenRef": "GITHUB_AUTH"
55+
}
3256
}
3357
}

0 commit comments

Comments
 (0)