Socket
Socket
Sign inDemoInstall

semantic-release-npm-github-publish

Package Overview
Dependencies
394
Maintainers
1
Versions
29
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

semantic-release-npm-github-publish

Sharable configuration for semantic-release, extends experience for publishing to NPM & Github: generates release-notes, changelog, publishes new version with Github actions.


Version published
Maintainers
1
Weekly downloads
1,401
decreased by-33.41%

Weekly downloads

Readme

Source

semantic-release-npm-github-publish

Version Version Documentation Maintenance License: MIT

Semantic-release shareable configuration for easy publishing to NPM, Github or Github Package Registry.

About

This sharable configuration conforms to angular standard

  • Using @semantic-release/commit-analyzer ensures that commits are conformed to the conventional commits specification.
    • 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.
  • Bumps a version in package.json.
  • Generates or updates a 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 for creation of sharable semantic-release configurations.

Install

  • Install semantic-release:
npm install --save-dev semantic-release
  • Add semantic-release to scripts:
"scripts": {
	"semantic-release": "semantic-release"
}
  • Install semantic-release-npm-github-publish:
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:

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.

Build with


This README was generated with ❤️ by readme-md-generator

Keywords

FAQs

Last updated on 22 Dec 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc