Skip to content

Commit

Permalink
Add release script and instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
stefandesu committed Feb 1, 2021
1 parent 4fba247 commit 5d2a9ed
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ JSKOS Server implements the JSKOS API web service and storage for [JSKOS] data s
- [Related works](#related-works)
- [Maintainers](#maintainers)
- [Contribute](#contribute)
- [Publish](#publish)
- [License](#license)

## Install
Expand Down Expand Up @@ -1798,10 +1799,19 @@ See [cocoda-sdk](https://github.com/gbv/cocoda-sdk) for efforts to provide unifo

## Contribute

PRs accepted.
PRs accepted against the `dev` branch.

Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.

### Publish
**For maintainers only**

Never work on the master branch directly. Always make changes on `dev` and then run the release script:

```bash
npm run release:patch # or minor or major
```

## License

MIT © 2018 Verbundzentrale des GBV (VZG)
Expand Down
6 changes: 5 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@
"import": "./bin/import.js",
"import-batch": "func() { tr '\\n' '\\0' < \"$2\" | xargs -0 -n1 ./bin/import.js $1; }; func",
"reset": "./bin/reset.js",
"upgrade": "./bin/upgrade.js"
"upgrade": "./bin/upgrade.js",
"release": "git checkout dev && git pull && npm test && npm version $SEMVER && git push && git checkout master && git merge dev && git push --follow-tags && git checkout dev",
"release:patch": "SEMVER=patch npm run release",
"release:minor": "SEMVER=minor npm run release",
"release:major": "SEMVER=major npm run release"
},
"lint-staged": {
"**/*.js": [
Expand Down

0 comments on commit 5d2a9ed

Please sign in to comment.