semantic-release-presets v4.1.3

semantic-release-presets

🔧 Semantic release presets and plugins for various projects.

This is not in any way connected or related to the official semantic-release group and only maintained by me and optimized for my usage with Gitlab.

From v2 on this project contains definitions for gitlab and github. They are identically but targeting the respecting platforms.

Usage

Register the package in your package.json as followed:

  ...

  "dependencies": {
    "semantic-release-presets": "{VERSION}",
    ...

Plugins

Currently one plugin is added:

MS Teams

This was forked from https://github.com/wagaru/semantic-release-teams and updated. Furthermore it was extended with ideas from https://github.com/yllieth/semantic-release-ms-teams .

If you do not want to use this plugin, but still want to use these presets you can set the environment variable TEAMS_WEBHOOK_DISABLED to true. This will skip the steps.

Presets

These presets make certain assumptions regarding your project setup. Please check them carefully if they apply to your workflows. If they do not match 100% you still can get some inspiration and adjust your configuration to your needs.

Following presets can be used:

GitHub

Full

No NPM publish (Node)

.NET

Nuget

Python

Swagger

Gitlab

Full

No NPM publish (Node)

.NET

Nuget

Python

Swagger

Recommendation

Based on your git knowledge and application or package release cycle, different configurations might be best suited for you:

Package and advanced Git knowledge (rebasing, branching)

If you are an advanced git user with rebasing and branching knowledge and maintain an npm or dotnet package, the configurations .releaserc.full.json or .releaserc.nuget.json might be beneficial for you.\ They provide support for normal version publishing, pre-releases and maintenance handling.\ Branches:

• main: normal version publishing
• dev: beta releases
• alpha: alpha releases
• N.x.x: maintenance handling (e.g. 1.x.x handles all version 1 maintenance releases)

Package with basic Git knowledge

If you have basic git knowledge and maintain an npm or dotnet package, the configurations .releaserc.main-full.json or .releaserc.main-nuget.json might be beneficial for you.\ They provide support for normal version publishing on branch main.

Application development

If you mainain an application you can check the configurations with main or dev in the name. They define the branch the release will be triggered.\ Most suitable should be the dev handling. This means you develop and release on this branch and merge into main for manual deployment.

Usage

Add it to your .releaserc.json:

{
  "extends": "semantic-release-presets/presets/github/.releaserc.full.json"
}

Support