Skip to content

Commit 9b1e5c9

Browse files
committed
chore: add release-it
1 parent ca3d42c commit 9b1e5c9

File tree

3 files changed

+2477
-37
lines changed

3 files changed

+2477
-37
lines changed

RELEASE.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Releases
2+
3+
1. Check that notable PRs since the last release are labeled and have clear and consistent titles
4+
5+
2. `git pull` the latest `master` and ensure that `git status` shows no local changes
6+
7+
3. `export GITHUB_AUTH="..."` with a [GitHub access token](https://github.com/settings/tokens/new?scopes=repo&description=release-it) with "repo" access so [release-it](https://github.com/release-it/release-it) can conduct a GitHub release and [lerna-changelog](https://github.com/lerna/lerna-changelog) can download the change history
8+
9+
4. `export EDITOR="vim"` to choose an editor for editing the changelog
10+
11+
5. `npm run release` (uses [@release-it-plugins/lerna-changelog](https://github.com/release-it-plugins/lerna-changelog) to handle versioning, the changelog, publishing to GitHub and NPM, etc)

package.json

+20-2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"lint:eslint-docs": "yarn update:eslint-docs --check",
1818
"lint:js": "eslint .",
1919
"lint:js:fix": "yarn lint:js --fix",
20+
"release": "release-it",
2021
"test": "mocha tests --recursive",
2122
"update:eslint-docs": "eslint-doc-generator"
2223
},
@@ -25,6 +26,7 @@
2526
"requireindex": "^1.2.0"
2627
},
2728
"devDependencies": {
29+
"@release-it-plugins/lerna-changelog": "^5.0.0",
2830
"eslint": "^8.0.0",
2931
"eslint-config-prettier": "^8.0.0",
3032
"eslint-doc-generator": "^1.0.2",
@@ -34,7 +36,8 @@
3436
"markdownlint-cli": "^0.32.0",
3537
"mocha": "^10.0.0",
3638
"npm-run-all": "^4.1.5",
37-
"prettier": "^2.0.0"
39+
"prettier": "^2.0.0",
40+
"release-it": "^15.5.1"
3841
},
3942
"peerDependencies": {
4043
"eslint": ">= 7"
@@ -53,5 +56,20 @@
5356
"bugs": {
5457
"url": "https://github.com/emberjs/eslint-plugin-ember-internal/issues"
5558
},
56-
"homepage": "https://github.com/emberjs/eslint-plugin-ember-internal#readme"
59+
"homepage": "https://github.com/emberjs/eslint-plugin-ember-internal#readme",
60+
"release-it": {
61+
"plugins": {
62+
"@release-it-plugins/lerna-changelog": {
63+
"infile": "CHANGELOG.md",
64+
"launchEditor": true
65+
}
66+
},
67+
"git": {
68+
"tagName": "v${version}"
69+
},
70+
"github": {
71+
"release": true,
72+
"tokenRef": "GITHUB_AUTH"
73+
}
74+
}
5775
}

0 commit comments

Comments
 (0)