https://github.com/oleg-koval/semantic-release-npm-github-publish
Github template for sharable configuration of semantic-release It helps with publishing to npm & Github generates changelog & release notes for any type of keywords.
https://github.com/oleg-koval/semantic-release-npm-github-publish
changelog github-actions github-package-registry github-publish hacktoberfest hacktoberfest2021 hactoberfest npm-publish package-template publish registry release release-automation release-notes releaserc semantic-release semantic-release-config sharable-config
Last synced: about 1 year ago
JSON representation
Github template for sharable configuration of semantic-release It helps with publishing to npm & Github generates changelog & release notes for any type of keywords.
- Host: GitHub
- URL: https://github.com/oleg-koval/semantic-release-npm-github-publish
- Owner: oleg-koval
- License: mit
- Created: 2019-09-26T13:22:25.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T16:20:53.000Z (about 2 years ago)
- Last Synced: 2025-04-14T07:07:49.419Z (about 1 year ago)
- Topics: changelog, github-actions, github-package-registry, github-publish, hacktoberfest, hacktoberfest2021, hactoberfest, npm-publish, package-template, publish, registry, release, release-automation, release-notes, releaserc, semantic-release, semantic-release-config, sharable-config
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/semantic-release-npm-github-publish
- Size: 496 KB
- Stars: 32
- Watchers: 2
- Forks: 17
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# semantic-release-npm-github-publish
> Semantic-release shareable configuration for easy publishing to NPM, Github or Github Package Registry.
## About
> This [sharable configuration](https://github.com/semantic-release/semantic-release/blob/master/docs/extending/shareable-configurations-list.md) conforms to [angular standard](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular)
- Using [@semantic-release/commit-analyzer](https://github.com/semantic-release/commit-analyzer) ensures that commits are conformed to the [conventional commits specification](https://www.conventionalcommits.org/en/v1.0.0-beta.4/).
- **PATCH** version created if any of **build, ci, chore, docs, refactor, style, test** commit types pushed to master
- **MINOR** version created if **fix** commit type pushed
- **MAJOR** version created if **feat** commit type pushed
- Publishes the new version to [NPM](https://npmjs.org).
- Bumps a version in package.json.
- Generates or updates a [changelog](https://github.com/semantic-release/changelog) file including all **PATCH** keywords (not included in default angular package).
- Releases new release for NPM & Github.
**This repository can be also used as a [template repository](https://help.github.com/en/articles/creating-a-template-repository) for creation of sharable semantic-release configurations.**
## Install
- Install `semantic-release`:
```sh
npm install --save-dev semantic-release
```
- Add `semantic-release` to scripts:
```json
"scripts": {
"semantic-release": "semantic-release"
}
```
- Install `semantic-release-npm-github-publish`:
```sh
npm install --save-dev semantic-release-npm-github-publish
```
- Add `npx semantic-release` to a "Release" step of your CD setup
## Usage
To use this sharable config, extend your semantic release configuration in `.releaserc.yaml`:
```yaml
branch: master
ci: false
dryRun: false
debug: false
extends: "semantic-release-npm-github-publish"
```
## Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/oleg-koval/semantic-release-npm-github-publish/issues).
## Build with
- [Github actions](https://github.com/features/actions)
- [semantic-release](https://github.com/semantic-release/semantic-release)
---
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_