Skip to content

Commit

Permalink
ux(docs): provide a release changelog
Browse files Browse the repository at this point in the history
Also set up a documented release process.

Fixes #670.
  • Loading branch information
mightyiam committed Jun 18, 2020
1 parent 09f2d1c commit 616df35
Show file tree
Hide file tree
Showing 5 changed files with 1,526 additions and 12 deletions.
20 changes: 20 additions & 0 deletions .versionrc.json
Original file line number Diff line number Diff line change
@@ -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
}
}
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 3 additions & 2 deletions commitlint.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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", [
Expand Down
Loading

0 comments on commit 616df35

Please sign in to comment.