@hexonet/semantic-release-github-whmcsbase-config

@hexonet/semantic-release-github-whmcsbase-config

semantic-release shareable config to publish WHMCS Modules on GitHub. To be used for e.g. widget

Plugins

This shareable configuration uses the following plugins:

• @semantic-release/commit-analyzer
• @semantic-release/release-notes-generator
• @semantic-release/github
• @semantic-release/git
• @semantic-release/exec
• @semantic-release/changelog

Summary

• Provides an informative git commit message for the release commit that does not trigger continuous integration and conforms to the conventional commits specification (e.g., "chore(release): 1.2.3 [skip ci]\n\nnotes").
• Creates or updates a changelog file that gets included in the release commit.
• Updates version numbers in several files using the repository specific script updateVersion.sh that get included in the release commit.
• Creates a zip using make allarchives that gets included in the release commit to make the latest version downloadable via release-independent URL.
• Creates a zip and tar.gz archive using make allarchives that get uploaded with each GitHub release to have release-dependent downloads.

Install

npm i -D semantic-release @hexonet/semantic-release-github-whmcsbase-config

Usage

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

{
  "extends": "@hexonet/semantic-release-github-whmcsbase-config",
  "branch": "master"
}

Configuration

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

• GH_TOKEN with public_repo access.

See each plugin documentation for required installation and configuration steps.