@auto-it/pr-body-labels

v11.1.6

Allow outside contributors to indicate what semver label should be applied to the Pull Request For more information about how to use this package see README

Latest version published 1 month ago

License: MIT

NPM

GitHub

Package Health Score

81 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
11.1.6	\|	04/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.0.7	\|	02/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.46.0	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.37.6	\|	09/2022	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
9.61.0	\|	10/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (593)

GitHub Stars: 2.18K
Forks: 200
Contributors: 100

Direct Usage Popularity

The npm package @auto-it/pr-body-labels receives a total of 593 downloads a week. As such, we scored @auto-it/pr-body-labels popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @auto-it/pr-body-labels, we found that it has been starred 2,181 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 100
Funding: No

With more than 10 contributors for the @auto-it/pr-body-labels repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 101
Open PR: 33
Last Release: 1 month ago
Last Commit: 1 month ago

Further analysis of the maintenance status of @auto-it/pr-body-labels based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @auto-it/pr-body-labels demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 4 Direct
Versions: 175
Install Size: 9.04 kB
Dist-tags: 2
# of Files: 7
Maintainers: 1
TS Typings: No

@auto-it/pr-body-labels has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Pr-Body-Labels Plugin

Allow outside contributors to indicate what semver label should be applied to the Pull Request. If you run auto pr-check from your CI this plugin will look at the PR body to find what label to apply.

Installation

This plugin is not included with the auto CLI installed via NPM. To install:

npm i --save-dev @auto-it/pr-body-labels
# or
yarn add -D @auto-it/pr-body-labels

Usage

{
  "plugins": [
    ["pr-body-labels"]
    // other plugins
  ]
}

Then something like the following to your .github/PULL_REQUEST_TEMPLATE.md. The only part of this that really matters is a markdown checkbox + one of your labels. You control what labels an outside contributor can apply through the PR body. This example only exposes the semantic versioning labels but you can include any label in your project.

## Change Type

Indicate the type of change your pull request is:

- [ ] `patch`
- [ ] `minor`
- [ ] `major`

Options

`disabledLabels`

Labels the user cannot apply through the PR.

{
  "plugins": [["pr-body-labels", { "disabledLabels": ["release"] }]]
}

`removeStaleLabels`

When using the plugin it will use the checklist in your PR body as the source of truth. This means that manually added label that are present in the pr-body will be removed when pr-check runs again. To disable this behavior use the removeStaleLabels option.

{
  "plugins": [["pr-body-labels", { "removeStaleLabels": false }]]
}

@auto-it/pr-body-labels dependencies

@auto-it/core fp-ts io-ts tslib

FAQs

What is @auto-it/pr-body-labels?

Allow outside contributors to indicate what semver label should be applied to the Pull Request. Visit Snyk Advisor to see a full health score report for @auto-it/pr-body-labels, including popularity, security, maintenance & community analysis.

Is @auto-it/pr-body-labels popular?

The npm package @auto-it/pr-body-labels receives a total of 593 weekly downloads. As such, @auto-it/pr-body-labels popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @auto-it/pr-body-labels well maintained?

We found that @auto-it/pr-body-labels demonstrated a healthy version release cadence and project activity. It has a community of 100 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @auto-it/pr-body-labels safe to use?

The npm package @auto-it/pr-body-labels was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 3 May-2024, at 12:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP