Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eclass/template-semantic-release-plugin

Template to generate semantic-release plugins
https://github.com/eclass/template-semantic-release-plugin

github-templates semantic-release-plugin

Last synced: about 1 month ago
JSON representation

Template to generate semantic-release plugins

Host: GitHub
URL: https://github.com/eclass/template-semantic-release-plugin
Owner: eclass
License: mit
Created: 2019-11-05T17:47:45.000Z (about 5 years ago)
Default Branch: master
Last Pushed: 2024-08-27T21:15:01.000Z (4 months ago)
Last Synced: 2024-08-27T22:57:13.499Z (4 months ago)
Topics: github-templates, semantic-release-plugin
Language: JavaScript
Size: 706 KB
Stars: 2
Watchers: 4
Forks: 0
Open Issues: 40
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # @eclass/semantic-release-custom-plugin

[![npm](https://img.shields.io/npm/v/@eclass/semantic-release-custom-plugin.svg)](https://www.npmjs.com/package/@eclass/semantic-release-custom-plugin)

[![build](https://img.shields.io/travis/eclass/semantic-release-custom-plugin.svg)](https://travis-ci.org/eclass/semantic-release-custom-plugin)

[![downloads](https://img.shields.io/npm/dt/@eclass/semantic-release-custom-plugin.svg)](https://www.npmjs.com/package/@eclass/semantic-release-custom-plugin)

[![dependencies](https://img.shields.io/david/eclass/semantic-release-custom-plugin.svg)](https://david-dm.org/eclass/semantic-release-custom-plugin)

[![devDependency Status](https://img.shields.io/david/dev/eclass/semantic-release-custom-plugin.svg)](https://david-dm.org/eclass/semantic-release-custom-plugin#info=devDependencies)

[![Coverage Status](https://coveralls.io/repos/github/eclass/semantic-release-custom-plugin/badge.svg?branch=master)](https://coveralls.io/github/eclass/semantic-release-custom-plugin?branch=master)

[![Maintainability](https://api.codeclimate.com/v1/badges/f84f0bcb39c9a5c5fb99/maintainability)](https://codeclimate.com/github/eclass/semantic-release-custom-plugin/maintainability)

[![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)

> [semantic-release](https://github.com/semantic-release/semantic-release) plugin to deploy app

| Step               | Description                                                                                 |

|--------------------|---------------------------------------------------------------------------------------------|

| `verifyConditions` | Verify the presence of the `CUSTOM_ENV` environment variable. |

| `publish`          | Deploy app.                                                                   |

## Install

```bash

npm i -D @eclass/semantic-release-custom-plugin

```

## Usage

The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/caribou/docs/usage/configuration.md#configuration):

```json

{

  "plugins": [

    "@semantic-release/changelog",

    "@semantic-release/npm",

    "@semantic-release/git",

    "@semantic-release/gitlab",

    "@eclass/semantic-release-custom-plugin"

  ]

}

```

## Configuration

### Environment variables

| Variable             | Description                                                       |

| -------------------- | ----------------------------------------------------------------- |

| `CUSTOM_ENV` | A custom env var |

### Examples

```json

{

  "plugins": [

    "@semantic-release/changelog",

    "@semantic-release/npm",

    "@semantic-release/git",

    "@semantic-release/gitlab",

    "@eclass/semantic-release-custom-plugin"

  ]

}

```

```yml

# .gitlab-ci.yml

release:

  image: node:alpine

  stage: release

  script:

    - npx semantic-release

  only:

    - master

```

```yml

# .travis.yml

language: node_js

cache:

  directories:

    - ~/.npm

node_js:

  - "12"

stages:

  - test

  - name: deploy

    if: branch = master

jobs:

  include:

    - stage: test

      script: npm t

    - stage: deploy

      script: npx semantic-release

```

## License

[MIT](https://tldrlegal.com/license/mit-license)