Skip to content

Commit 4ac96ab

Browse files
committedNov 22, 2022
chore: add release-it
1 parent 163bfdf commit 4ac96ab

File tree

4 files changed

+5657
-461
lines changed

4 files changed

+5657
-461
lines changed
 

‎RELEASE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Release Instructions
2+
3+
1. `git pull` the latest master and ensure that `git status` shows no local changes
4+
5+
2. `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
6+
7+
3. `export EDITOR="vim"` to choose an editor for editing the changelog
8+
9+
4. `npm run release` (uses [@release-it-plugins/conventional-changelog](https://github.com/release-it/conventional-changelog) to handle versioning, the changelog, publishing to GitHub and NPM, etc)

‎build/generate-release-changelog.js

-54
This file was deleted.

‎package-lock.json

+5,637-404
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+11-3
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010
"lint:js": "eslint --cache --report-unused-disable-directives .",
1111
"preversion": "npm test",
1212
"report-coverage-html": "nyc report --reporter=html --report-dir build/coverage",
13+
"release": "release-it",
1314
"test": "npm-run-all lint test:unit",
1415
"test:unit": "nyc mocha tests/**/*.js",
15-
"update:eslint-docs": "eslint-doc-generator --url-configs \"https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations\"",
16-
"version": "node build/generate-release-changelog.js"
16+
"update:eslint-docs": "eslint-doc-generator --url-configs \"https://github.com/platinumazure/eslint-plugin-qunit/blob/master/README.md#configurations\""
1717
},
1818
"files": [
1919
"index.js",
@@ -42,8 +42,8 @@
4242
"npm-run-all": "^4.1.5",
4343
"nyc": "^15.1.0",
4444
"outdent": "^0.8.0",
45+
"release-it": "^15.5.0",
4546
"semver": "^7.3.7",
46-
"shelljs": "^0.8.4",
4747
"typescript": "^4.7.4"
4848
},
4949
"peerDepencencies": {
@@ -83,5 +83,13 @@
8383
"homepage": "https://github.com/platinumazure/eslint-plugin-qunit",
8484
"engines": {
8585
"node": "12.x || 14.x || >=16.0.0"
86+
},
87+
"release-it": {
88+
"git": {
89+
"commitMessage": "chore: release v${version}"
90+
},
91+
"github": {
92+
"release": true
93+
}
8694
}
8795
}

0 commit comments

Comments
 (0)
Please sign in to comment.