https://github.com/stipsan/release-relief
It's easy to burnout when you're being an Open Source maintainer. Reducing chores around releasing helps with the fatigue.
https://github.com/stipsan/release-relief
nodejs npm-package open-source release-automation release-management
Last synced: 12 months ago
JSON representation
It's easy to burnout when you're being an Open Source maintainer. Reducing chores around releasing helps with the fatigue.
- Host: GitHub
- URL: https://github.com/stipsan/release-relief
- Owner: stipsan
- License: mit
- Created: 2017-09-30T18:59:55.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-25T02:49:58.000Z (over 1 year ago)
- Last Synced: 2025-01-12T17:41:51.008Z (over 1 year ago)
- Topics: nodejs, npm-package, open-source, release-automation, release-management
- Size: 8.79 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# release-relief · [](https://circleci.com/gh/stipsan/release-relief) [](https://www.npmjs.com/package/release-relief) [](https://github.com/semantic-release/semantic-release)
It's easy to burnout when you're being an Open Source maintainer. Reducing chores around releasing helps with the fatigue.
I'm making this package to help reduce boilerplate and make it easier to setup a semantic-release flow for my npm published packages.
My decisions on what CI to primarily use and commit conventions is specific to my needs. I don't expect others to use this package directly so documentation will be scarce.
Should this change then feel free to open an issue with any question you might have if this package is helpful to you :smile:
# Setup
Add `release-relief` to your devDependencies:
```bash
yarn add --dev release-relief
```
Add the following to your package.json:
```json
"scripts": {
"changelog:preview": "sr-changelog",
"changelog:commit": "sr-changelog commit",
"semantic-release": "semantic-release pre && npm publish && semantic-release post"
},
"release": {
"analyzeCommits": "semantic-release-tamia/analyzeCommits",
"verifyConditions": "condition-circle",
"generateNotes": "semantic-release-tamia/generateNotes",
"verifyRelease": "semantic-release-tamia/verifyRelease"
},
```
Then setup your CI, I prefer circleci which is why [condition-circle](https://www.npmjs.com/package/condition-circle) is set as the `verifyConditions` step, even on [this repo](https://github.com/stipsan/release-relief/blob/f25c65ddff64aff74555db92f80197bc3a9c7352/.circleci/config.yml#L24).
Read more about the setup here: https://github.com/tamiadev/semantic-release-tamia