Profile Semantic Release App Config

Shareable Semantic Release Configuration

Plugins

This shareable configuration uses the following plugins:

• @semantic-release/commit-analyzer

• @semantic-release/release-notes-generator

• @semantic-release/npm

• @semantic-release/git

Install

$ npm install --save-dev semantic-release @tomchinery/semantic-release-app-config

Usage

The shareable config can be configured in the semantic-release configuration file:

{
  "extends": "@tomchinery/semantic-release-app-config"
}

Configuration

See each plugin documentation for required installation and configuration steps.

Development

Commit Standards

This project enforces a Conventional Commits standard using:

• commitizen

• cz-conventional-changelog

As a prerequisite developers should install commitizen globally first:

npm install -g commitizen

To make commits there is a specific flow developers should follow:

1. Stage changed files using: git add .

2. Run through the cz-conventional-changelog prompts ensuring you provide enough details and a Jira issue number using: npm run commit

3. Push your branch using: git push

If you are unfamiliar with Conventional Commits please read more about it here here.

If you are unfamiliar with Commitizen please read more about it here.

If you are unfamiliar with cz-conventional-changelog please read more about it here.

Branching Strategy

This project follows a simplified Gitflow branching strategy.

There is only one branch to use main.

Feature and Fix branches should be created for any new changes against the main branch.

Your branch should then be Pull Requested into main where it will be reviewed and merged by a maintainer of the project.

If you are unfamiliar with a Gitflow branching strategy please read more about it here.