https://github.com/eliasnorrby/semantic-release-config

:hammer: Reusable semantic-release config for small projects
https://github.com/eliasnorrby/semantic-release-config

cicd config semantic-release

Last synced: 2 days ago
JSON representation

:hammer: Reusable semantic-release config for small projects

• Host: GitHub
• URL: https://github.com/eliasnorrby/semantic-release-config
• Owner: eliasnorrby
• License: mit
• Created: 2019-09-18T09:46:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-06T19:40:14.000Z (over 1 year ago)
• Last Synced: 2024-12-22T23:09:07.446Z (4 days ago)
• Topics: cicd, config, semantic-release
• Language: JavaScript
• Homepage:
• Size: 884 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Semantic Release Config

[![Travis](https://img.shields.io/travis/com/eliasnorrby/semantic-release-config?style=for-the-badge)](https://travis-ci.com/eliasnorrby/semantic-release-config)

[![npm](https://img.shields.io/npm/v/@eliasnorrby/semantic-release-config?style=for-the-badge)](https://www.npmjs.com/package/@eliasnorrby/semantic-release-config)

[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&repo=eliasnorrby/semantic-release-config)](https://dependabot.com)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

My semantic-release config. It extends the default configuration by adding the

`changelog` and `git` plugins.

:warning: This project is no longer actively maintained :warning:

# Setup

## Using `npx`

Run the following command to install and configure semantic-release

```sh

npx @eliasnorrby/semantic-release-config

```

This will run a setup script, adding this package to `devDependencies` and

writing the config to `.releaserc.js`.

### `--no-install`

Run setup with the `--no-install` flag to avoid installing this package as a

dependency. Your `.releaserc.js` will contain a sample list of plugins for you

to add to instead of extending this package.

## Manually

Install the package

```sh

npm i -D @eliasnorrby/semantic-release-config

```

and add the configuration to `.releaserc.js`.

### `.releaserc.js`

```js

module.exports = require('@eliasnorrby/semantic-release-config')

```

# Overriding settings

Just add your overrides to `.releaserc.js`:

```js

module.exports = {

  ...require('@eliasnorrby/semantic-release-config'),

  branch: 'production',

}

```