@szum-tech/semantic-release-config

Semantic-release shareable configuration.

Setting up a Semantic-release configuration should be easier.


Semantic-release shareable configuration to publish GitHub projects using GitHub Actions workflows.

---

📚 Features

- Uses Conventional Commits to generate
release notes,
changelogs and
determine the version for new releases.
- Creates or updates a CHANGELOG.md file.
- Publishes to npm (optional).
- Creates a new release on GitHub.
- Updates GitHub issues and PRs that are resolved by a new release.
- Commits and pushes the current version to package.json.
- Offers predefined configurations or configuration builder function

📖 Table of Contents

* 📚 Features
* 📖 Table of Contents
* 🎯 Getting Started
* ⚙️ Installation
* Configuration
* Predefined configs
* Configuration Builder
* 💻 Environment Variables Configuration
* 🚀 Minimal GitHub Release workflow
* 🛠️ Developer Info
* Dependencies
* 📓 Changelog
* 📜 License

🎯 Getting Started

$3

@szum-tech/semantic-release-config is available as
an npm package.

``shell


NPM

Basic information needed to understand, how to set up semantic-release configuration, you are able to find under
USAGE > Configuration in semantic-release
documentation.

#### Predefined configs

- without-npm - @szum-tech/semantic-release-config/without-npm - allows you to perform the code release process,
excluding publishing the code to npm
- with-npm - @szum-tech/semantic-release-config/with-npm - allows you to perform the code release process, including
publishing the code to npm

Predefined configurations could be set via either:

- A .releaserc file, written in YAML or JSON, with optional extensions: .yaml/.yml/.json/.js/.cjs/.mjs
- A release.config.(js|cjs|.mjs) file that exports an object
- A release key in the project's package.json file

The following examples show how to integrate predefined configuration in project:

- Via release.config.mjs file:

`js
export { default } from "@szum-tech/semantic-release-config/with-npm";
// OR
// export { config } from "@szum-tech/semantic-release-config/without-npm";
// if you don't want to publish your project on npm
`

Imported configurations also could be used to extends yours:

`js
/**
* @type {import('semantic-release').GlobalConfig}
*/
export default {
branches: ["master", "next"],
extends: "@szum-tech/semantic-release-config/with-npm"
// OR
// extends: "@szum-tech/semantic-release-config/without-npm";
// if you don't want to publish your project on npm
};
`

- Via release.config.cjs file:

`js
module.exports = require("@szum-tech/semantic-release-config/with-npm");
// OR
// module.exports = required("@szum-tech/semantic-release-config/without-npm");
// if you don't want to publish your project on npm
`

OR extend configuration

`js
/**
* @type {import('semantic-release').GlobalConfig}
*/
module.exports = {
branches: ["master", "next"],
extends: "@szum-tech/semantic-release-config/with-npm"
// OR
// extends: "@szum-tech/semantic-release-config/without-npm";
// if you don't want to publish your project on npm
};
`

- Via release key in the project's package.json file:

`json
{
"release": {
"extends": "@szum-tech/semantic-release-config/with-npm"
// OR
// "extends": "@szum-tech/semantic-release-config/without-npm";
// if you don't want to publish your project on npm
}
}
`

- Via .releaserc file:

`json
{
"extends": "@szum-tech/semantic-release-config/with-npm"
// OR
// "extends": "@szum-tech/semantic-release-config/without-npm";
// if you don't want to publish your project on npm
}
`

#### Configuration Builder

@szum-tech/semantic-release-config also returns the getConfig function:

`js
// For *.mjs
import { getConfig } from "@szum-tech/semantic-release-config";

// For *.cjs
const { getConfig } = require("@szum-tech/semantic-release-config");
`

This function takes an argument configurationOptions, where the is located features variable - defining configurable
features.

Features Table

| Name | Description | Type | Default Value |
| :--: | :---------------------------------------: | :-----: | :-----------: |
| npm | Defined if release will be publish on npm | Boolean | false |

The following examples show how to integrate configuration builder function in project:

- Via release.config.mjs file:

`js
import { getConfig } from "@szum-tech/semantic-release-config";

export default getConfig({ features: { npmPublish: true } });
`

- Via release.config.cjs file:

`js
const { getConfig } = require("@szum-tech/semantic-release-config");

module.exports = getConfig({ features: { npmPublish: true } });
`

💻 Environment Variables Configuration

Ensure that your CI configuration has the following environment variables set:

- GITHUB_TOKEN:
A GitHub personal access token
- NPM_TOKEN: A npm personal access token (optional if you don't publish
your project on npm)

🚀 Minimal GitHub Release workflow

This is the bare minimum required steps to trigger a new release. This will push a new release every time an eligible
commit is pushed to git. Check the opinionated flow to see how to trigger releases manually. Create
.github/workflows/publish.yml:

`yaml
name: Publish 🚀

on:
push:
branches: [main]

env:
NODE_VERSION: 22.x

jobs:
publish:
name: Publish 🚀
runs-on: ubuntu-latest
steps:
- name: Checkout code 📚
uses: actions/checkout@v4
- name: Set up Node 🟢
uses: actions/setup-node@v4
with:
node-version: ${{ env.NODE_VERSION }}
cache: "npm"
- name: Install packages ⚙️
run: npm ci
- name: Build 🏗️
run: npm run build
- name: Publish package 🚀
run: npx semantic-release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
``

> [!TIP]
> See also publish.yml file.

🛠️ Developer Info

$3

!NPM (prod) Dependency Version
!NPM (prod) Dependency Version
!NPM (prod) Dependency Version
!NPM (prod) Dependency Version
!NPM (prod) Dependency Version
!NPM (prod) Dependency Version
!NPM (prod) Dependency Version

📓 Changelog

The changelog is regularly updated to
reflect what's changed in each new release.

📜 License

This project is licensed under the terms of the
MIT license.