release-relief ·

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 😄

Setup

Add release-relief to your devDependencies:

yarn add --dev release-relief

Add the following to your package.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 is set as the verifyConditions step, even on this repo.

Read more about the setup here: https://github.com/tamiadev/semantic-release-tamia