ux(docs): provide a release changelog

Also set up a documented release process.

Fixes #670.
pull/698/head
Shahar Or (mightyiam) 5 years ago committed by Shahar Dawn Or
parent 09f2d1ca5a
commit 616df35909

@ -0,0 +1,20 @@
{
"types": [
{
"type": "auto",
"section": "Internal changes"
},
{
"type": "dx",
"section": "Internal changes"
},
{
"type": "ux",
"section": "User facing changes"
}
],
"releaseCommitMessageFormat": "release(package): {{currentTag}}",
"skip": {
"tag": true
}
}

@ -0,0 +1,32 @@
# Contributing
## Making a release
Make sure you have permission to publish, by running
npm access ls-collaborators
While on the `master` branch, switch to a new branch, possibly called `release`:
git switch --create release
npm run make-release-commit
Create a new pull request from this branch. The name of the pull request possibly identical to the commit message.
"Rebase and merge" the pull request.
git switch master
git pull
Where `$VERSION` is the new version, run
git tag v$VERSION
For example:
git tag v5.2.4
And then
git push --tags
npm publish

@ -16,8 +16,9 @@
"type-empty": [2, "never"],
"type-enum": [2, "always", [
"auto",
"ux",
"dx"
"dx",
"release",
"ux"
]],
"scope-empty": [2, "never"],
"scope-enum": [2, "always", [

1474
package-lock.json generated

File diff suppressed because it is too large Load Diff

@ -72,6 +72,7 @@
"p-reduce": "2.1.0",
"remark-cli": "8.0.0",
"remark-toc": "7.0.0",
"standard-version": "8.0.0",
"ts-transform-import-path-rewrite": "0.2.1",
"tsconfigs": "5.0.0",
"tty-table": "4.1.3",
@ -87,12 +88,10 @@
"lint": "run-s lint:editorconfig lint:js",
"unit": "cross-env FILES_PATTERN=\"build/test/unit/**/*.js\" karma start karma.conf.cjs",
"benchmark": "cross-env FILES_PATTERN=\"build/test/benchmark/**/*.js\" karma start karma.conf.cjs --concurrency=1",
"make-release-commit": "standard-version",
"test": "run-s lint compile unit",
"compile": "ttsc --build src/test/tsconfig.json",
"prepublishOnly": "npm run compile",
"release-major": "xyz --repo git@github.com:paldepind/snabbdom.git --increment major",
"release-minor": "xyz --repo git@github.com:paldepind/snabbdom.git --increment minor",
"release-patch": "xyz --repo git@github.com:paldepind/snabbdom.git --increment patch"
"prepublishOnly": "npm run compile"
},
"repository": {
"type": "git",

Loading…
Cancel
Save