\n\n\n## About\n\nThis is a convenience wrapper around [semantic-release](https://github.com/semantic-release/semantic-release) designed to be used with GitHub Actions. It uses [conventional commit messages](https://www.conventionalcommits.org/en/v1.0.0/) to generate release notes and a changelog. When a release is necessary, it is automatically published to npm, pushing the newly created tag, revised package.json and updated changelog to GitHub.\n\n## Installation\n\n```sh\npnpm add -D @douglasneuroinformatics/semantic-release husky\n```\n\n> Note: Husky is an optional peer dependency, and could be replaced with any other toolchain that ensures that conventional commits are followed.\n\n## Configuration\n\nFirst, setup Husky (if applicable):\n\n```sh\npnpm exec husky init\n```\n\nThen, add the following git hook:\n\n**`.husky/commit-msg`**\n\n```sh\n#!/bin/sh\n\npnpm exec commitlint --edit $1\n```\n\nNow, add the following configuration:\n\n**`package.json`**\n\n```json\n{\n \"commitlint\": {\n \"extends\": [\"@douglasneuroinformatics/semantic-release/commitlint-config\"]\n },\n \"release\": {\n \"extends\": [\"@douglasneuroinformatics/semantic-release\"]\n }\n}\n```\n\nNext, generate an access token for [npm](https://www.npmjs.com/) with read and write permissions for the package in question and set the `NPM_TOKEN` secret for the repository.\n\nThen, add the following workflow:\n\n**`.github/workflows/release.yaml`**\n\n```yaml\nname: Release\non:\n push:\n branches: ['main']\n workflow_dispatch:\npermissions:\n contents: read\njobs:\n release:\n permissions:\n contents: write\n issues: write\n pull-requests: write\n id-token: write\n uses: DouglasNeuroinformatics/semantic-release/.github/workflows/release.yaml@main\n secrets:\n NPM_TOKEN: ${{ secrets.NPM_TOKEN }}\n with:\n build-command: pnpm build # optional\n lint-command: pnpm lint # optional\n test-command: pnpm test # optional\n```\n","readmeFilename":"README.md"}
![\"Logo\"](\"https://raw.githubusercontent.com/DouglasNeuroInformatics/semantic-release/main/.github/assets/dnp-utility-logo.png\"){kind=logo}
\n \n