
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
semantic-release-github-pr
Advanced tools
A `semantic-release` plugin that creates a changelog comment on Github PRs.
Preview the semantic release notes that would result from merging a Github PR.
This semantic-release
plugin will post a Github PR comment with a preview of the release that would result from merging.
npm install -D semantic-release-github-pr
This plugin is a complement to semantic-release
. It is assumed the user is already fully familiar with that package and its workflow.
Github authentication must be configured for semantic-relase
.
The easiest way to use the plugin is through the CLI. If more flexibility is needed, the plugin can also be set through the semantic-release
config in package.json
.
Post a comment to any open Github PRs with a matching base branch and git head. Previous comments generated by this plugin will be removed.
npx semantic-release-github-pr
The semantic-release-github-pr
command is provided as a convenience. Internally, it simply wraps the semantic-release
command, using the necessary plugins hooks (see config below). Otherwise, it works just the same and accepts the same options .
package.json
configIf more flexibility is needed, the plugins can be configured manually. This package provides verifyConditions
(deletes old comments) and publish
(creates new commens) plugins.
Default configuration (as encapsulated in the semantic-release-github-pr
command):
{
"release": {
"publish": "semantic-release-github-pr",
"verifyConditions": ["@semantic-release/github", "semantic-release-github-pr"]
}
}
This plugin is best used with a CI build process to fully automate the posting of comments in Github PRs. Ideally, it should run whenever a PR is opened/updated.
To only run when necessary, we use the $TRAVIS_PULL_REQUEST
environment variable to detect whether the build is a "pull request build".
after_success:
- "[[ $TRAVIS_PULL_REQUEST != 'false' ]] npx semantic-release-github-pr"
To only run when necessary, we use the $CI_PULL_REQUEST
environment variable to detect whether the build has a corresponding pull request.
Unfortunately, CircleCI only supports building on push, not when a PR is created. This limits the usefulness of the plugin somewhat, as a build will have to be triggered manually after a PR is opened for the changelog to post.
test:
post:
- "[[ $CI_PULL_REQUEST != '' ]] npx semantic-release-github-pr"
FAQs
A `semantic-release` plugin that creates a changelog comment on Github PRs.
The npm package semantic-release-github-pr receives a total of 135 weekly downloads. As such, semantic-release-github-pr popularity was classified as not popular.
We found that semantic-release-github-pr demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
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.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.