https://github.com/eik-lib/semantic-release

Semantic release plugin for Eik that lets you automate version changes in eik.json using conventional commits
https://github.com/eik-lib/semantic-release

eik semantic-release-plugin

Last synced: about 1 month ago
JSON representation

Semantic release plugin for Eik that lets you automate version changes in eik.json using conventional commits

• Host: GitHub
• URL: https://github.com/eik-lib/semantic-release
• Owner: eik-lib
• Created: 2021-07-28T20:55:32.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T02:37:21.000Z (about 2 months ago)
• Last Synced: 2024-11-01T03:23:41.744Z (about 2 months ago)
• Topics: eik, semantic-release-plugin
• Language: JavaScript
• Homepage: https://eik.dev
• Size: 70.3 KB
• Stars: 0
• Watchers: 4
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# Eik Semantic Release Plugin

This plugin will first determine if a repo has changes to relevant files before versioning and publishing these files to an Eik server.

N.B. Currently, this plugin expects that your Eik project uses an `eik.json` file (rather than configuration in `package.json`)

## Setup

1. Setup Semantic Release as per guides

https://semantic-release.gitbook.io/semantic-release/usage/getting-started

### Consider using the interactive CLI

```

npx semantic-release-cli setup

```

2. Install plugins

```

npm install -D @eik/semantic-release @semantic-release/git

```

3. Create/edit `release.config.js` file to load plugins

```js

export default {

    plugins: [

        '@eik/semantic-release',

        ['@semantic-release/git', { assets: ['eik.json'] }],

    ],

};

```

## Plugin Environment Variables

This plugin expects the following environment variable to be present.

| Name      | Description                 |

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

| EIK_TOKEN | Access token for Eik server |