https://github.com/Nick-Mazuk/semantic-release-config
semantic-release config
https://github.com/Nick-Mazuk/semantic-release-config
semantic-release semantic-release-config
Last synced: 17 days ago
JSON representation
semantic-release config
- Host: GitHub
- URL: https://github.com/Nick-Mazuk/semantic-release-config
- Owner: Nick-Mazuk
- Created: 2021-05-05T17:13:05.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-17T20:15:36.000Z (about 1 month ago)
- Last Synced: 2025-04-18T10:39:27.788Z (about 1 month ago)
- Topics: semantic-release, semantic-release-config
- Language: JavaScript
- Homepage:
- Size: 363 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Semantic release config
A config for [semantic-release](https://github.com/semantic-release/semantic-release).
- Adds a few extra commit types
- Creates changelog automatically
- Pushes changelog back into Git repo
## Installation
Install the config and it's peer dependencies.
```bash
pnpm i -D @nick-mazuk/semantic-release-config semantic-release @semantic-release/changelog @semantic-release/git
```
Create a `release.config.cjs` file in the root of your repo.
```js
module.exports = {
extends: ['@nick-mazuk/semantic-release-config'],
}
```
## Usage with GitHub Actions
Create a `.github/workflows/release.yml` file.
```yml
name: Release
on:
push:
branches:
- main
jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/[email protected]
with:
node-version: 14
- name: Install dependencies
run: npx pnpm i --frozen-lockfile=false
- name: Release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
run: npx semantic-release
```
Add your `NPM_TOKEN` token to your repository's secrets.
## Available commit types
- **build**: Changes that affect the build system (example scopes: gulp, broccoli, npm)
- **bump**: Dependency updates
- **ci**: Changes to our CI configuration files and scripts (example scopes: Circle, BrowserStack, SauceLabs)
- **docs**: Documentation only changes
- **feat**: A new feature
- **fix**: A bug fix
- **perf**: A code change that improves performance
- **refactor**: A code change that neither fixes a bug nor adds a feature
- **test**: Adding missing tests or correcting existing tests
- **style**: A change in CSS
- **BREAKING**: Any breaking change