https://github.com/devpow112/semantic-release-config
:clipboard: Shareable semantic-release configuration
https://github.com/devpow112/semantic-release-config
dependabot github-actions nodejs semantic-release semantic-release-config
Last synced: about 1 month ago
JSON representation
:clipboard: Shareable semantic-release configuration
- Host: GitHub
- URL: https://github.com/devpow112/semantic-release-config
- Owner: devpow112
- License: mit
- Created: 2022-02-03T03:54:43.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T17:01:11.000Z (7 months ago)
- Last Synced: 2024-10-30T18:17:06.903Z (7 months ago)
- Topics: dependabot, github-actions, nodejs, semantic-release, semantic-release-config
- Language: JavaScript
- Homepage: https://npmjs.com/@devpow112/semantic-release-config
- Size: 1.14 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Semantic Release Configuration
[![License][License Badge]](LICENSE)
[![Version][Version Badge]][Version Package]
[![Release][Release Badge]][Release Workflow]
[![Node Version][Node Version Badge]](package.json#L51)
Shareable semantic release configuration.
## Installation
```console
npm i -D @devpow112/semantic-release-config
```
## Usage
The shareable config can be configured in the [Semantic Release configuration]
file.
```json
{
"extends": "@devpow112/semantic-release-config"
}
```
## Development
Development can be done on any machine that can install **Node.js**. Only the
latest LTS version is tested against.
### Install Dependencies
Install dependencies via `npm`.
```console
npm i
```
### Linting
Execute linters via `npm`.
```console
# git, javascript, markdown and package.json
npm run lint
# git only
npm run lint:git
# javascript only
npm run lint:js
# markdown only
npm run lint:md
# package.json only
npm run lint:pkg
```
### Fixing
Execute automatic fixers via `npm`.
```console
# javascript, markdown and package.json
npm run fix
# javascript only
npm run fix:js
# markdown only
npm run fix:md
# package.json only
npm run fix:pkg
```
[License Badge]: https://img.shields.io/github/license/devpow112/semantic-release-config?label=License
[Version Badge]: https://img.shields.io/npm/v/@devpow112/semantic-release-config?label=Version
[Version Package]: https://www.npmjs.com/@devpow112/semantic-release-config
[Node Version Badge]: https://img.shields.io/node/v/@devpow112/semantic-release-config
[Release Badge]: https://github.com/devpow112/semantic-release-config/actions/workflows/release.yml/badge.svg?branch=main
[Release Workflow]: https://github.com/devpow112/semantic-release-config/actions/workflows/release.yml?query=branch%3Amain
[Semantic Release configuration]: https://semantic-release.gitbook.io/semantic-release/usage/shareable-configurations