https://github.com/eik-lib/semantic-release-config
Shared semantic release config used in Eik modules
https://github.com/eik-lib/semantic-release-config
eik semantic-release-config
Last synced: about 2 months ago
JSON representation
Shared semantic release config used in Eik modules
- Host: GitHub
- URL: https://github.com/eik-lib/semantic-release-config
- Owner: eik-lib
- Created: 2024-07-30T11:36:37.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T02:39:57.000Z (9 months ago)
- Last Synced: 2024-09-17T06:16:45.766Z (9 months ago)
- Topics: eik, semantic-release-config
- Language: JavaScript
- Homepage: https://eik.dev
- Size: 11.7 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# @eik/semantic-release-config
This is a [semantic-release](https://github.com/semantic-release/semantic-release) config to publish Eik modules meant for internal use in the [eik-lib organisation](https://github.com/eik-lib).
This configuration is not related to our [semantic release plugin](https://github.com/eik-lib/semantic-release#readme).
## Plugins
This shareable configuration uses the following plugins:
- [`@semantic-release/commit-analyzer`](https://github.com/semantic-release/commit-analyzer)
- [`@semantic-release/release-notes-generator`](https://github.com/semantic-release/release-notes-generator)
- [`@semantic-release/changelog`](https://github.com/semantic-release/changelog)
- [`@semantic-release/npm`](https://github.com/semantic-release/npm)
- [`@semantic-release/github`](https://github.com/semantic-release/github)
- [`@semantic-release/git`](https://github.com/semantic-release/git)
## Install
```bash
npm install --save-dev semantic-release @eik/semantic-release-config
```
## Usage
In the [semantic-release configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration):
```js
export default {
extends: "@eik/semantic-release-config",
};
```
If you add your own plugins you need to include the ones from the shared config.
```js
import config from '@eik/semantic-release-config';
export default {
extends: '@eik/semantic-release-config',
plugins: [
...config.plugins,
[
'extra-plugin',
{ pluginOpts },
],
],
};
```