Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

release-please

Package Overview
Dependencies
Maintainers
2
Versions
383
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

release-please

generate release PRs based on the conventionalcommits.org spec

  • 15.8.1
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
451K
increased by29.43%
Maintainers
2
Weekly downloads
 
Created

What is release-please?

release-please is an automated release tool for GitHub repositories. It automates the process of generating release notes, creating GitHub releases, and versioning based on conventional commits. This helps maintainers streamline their release process and ensure consistency.

What are release-please's main functionalities?

Automated Release Notes

This feature allows you to automatically generate release notes based on the commits in your repository. The code sample demonstrates how to create a GitHub release with release notes.

const { GitHubRelease } = require('release-please');
const githubRelease = new GitHubRelease({
  repoUrl: 'https://github.com/owner/repo',
  packageName: 'my-package',
  token: 'your-github-token'
});
githubRelease.createRelease();

Version Bumping

This feature automates the process of bumping the version of your package based on the commits. The code sample shows how to bump the version of your package.

const { Version } = require('release-please');
const version = new Version({
  repoUrl: 'https://github.com/owner/repo',
  packageName: 'my-package',
  token: 'your-github-token'
});
version.bumpVersion();

Changelog Generation

This feature generates a changelog file based on the commits in your repository. The code sample demonstrates how to generate a changelog.

const { Changelog } = require('release-please');
const changelog = new Changelog({
  repoUrl: 'https://github.com/owner/repo',
  packageName: 'my-package',
  token: 'your-github-token'
});
changelog.generateChangelog();

Other packages similar to release-please

Keywords

FAQs

Package last updated on 07 Mar 2023

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc