@foyer/semantic-release-config

Semantic release Config Foyer

A Semantic release config for Foyer

Installation

Dependent on semantic-release @semantic-release/git @semantic-release/changelog Install @semantic-release/exec to run any custom custom scripts on different state of release hooks.

npm install @foyer/semantic-release-config semantic-release @semantic-release/git @semantic-release/changelog --save-dev

Usage

In package.json:

"scripts": {
  "release": "semantic-release --no-ci",
}

In release.config.js:

module.exports = {
  extends: '@foyer/semantic-release-config',
  branch: 'develop', // any specific overrides
}

Usage with utilizing release hooks

In release.config.js:

module.exports = {
  extends: '@foyer/semantic-release-config',
  branch: 'develop', // any specific overrides
  plugins: [
    ...require('@foyer/semantic-release-config')['plugins'],
    [
      '@semantic-release/github',
      {
        assets: [{ path: 'dist/release.zip', name: 'Foyer.zip', label: 'Foyer App' }],
        successComment: 'This ${issue.pull_request ? "pull request" : "issue"} is included in version ${nextRelease.version}',
        failComment: 'This release from branch ${branch} had failed due to the following errors:\n- ${errors.map(err => err.message).join("\\n- ")}',
      },
    ],
    [
      '@semantic-release/exec',
      {
        prepareCmd: './config/release/prepare-publish.sh',
        successCmd: './config/release/success.sh',
      },
    ],
  ],
}

License

MIT