@auto-it/version-file

v11.3.0

For managing versions in a repository that maintains the version primarily in a flat file. Agnostic to the primary language of the repository. Optional input for a release script to call during the publish/canary/next hooks. For more information about how to use this package see README

Latest version published 28 days ago

License: MIT

NPM

GitHub

Package Health Score

81 / 100

security
No known security issues
popularity
Popular
maintenance
Healthy
community
Sustainable

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.3.0	\|	10/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
11.2.1	\|	08/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
10.45.2	\|	04/2023		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.44.0	\|	04/2023		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

Popular

Weekly Downloads (65,889)

GitHub Stars: 2.25K
Forks: 202
Contributors: 100

Direct Usage Popularity

The npm package @auto-it/version-file receives a total of 65,889 downloads a week. As such, we scored @auto-it/version-file popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @auto-it/version-file, we found that it has been starred 2,251 times.

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

Community

Sustainable

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

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

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 108
Open PR: 36
Last Release: 28 days ago
Last Commit: 3 months ago

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

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

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: 3 years
Dependencies: 5 Direct
Versions: 45
Install Size: 21.2 kB
Dist-tags: 1
# of Files: 7
Maintainers: 1
TS Typings: No

@auto-it/version-file 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

Version File Plugin

For managing versions in a repository that maintains the version primarily in a flat file. Agnostic to the primary language of the repository. Optional input for a release script to call during the publish/canary/next hooks.

Installation

This plugin is included with the auto CLI so you do not have to install it. To install if you are using the auto API directly:

npm i --save-dev @auto-it/version-file
# or
yarn add -D @auto-it/version-file

Options

versionFile (optional, default="VERSION"): Path to where the version is stored in the repository. It should be a file containing just the semver.
publishScript: (optional, default=None): Path to script that runs the publish actions in your repository. If not supplied nothing will be called. If supplied will be called during the publish,canary and next hooks with the arguments defined in publishScriptReleaseTypeArgs for that release type.
publishScriptReleaseTypeArgs: (optional, default={ "publish": ["release"], "canary": ["snapshot"], "next": ["snapshot"] }): Mapping of arguments to pass to the publishScript for each release type (publish, canary, next)

Usage

With default options

{
  "plugins": [
    "version-file"
    // other plugins
  ]
}

With optional arguments

{
  "plugins": [
    "version-file", {"versionFile": "./tools/Version.txt", "publishScript":"./tools/publish.sh", "publishScriptReleaseTypeArgs": {
      "publish": ["release"], // (default)
      "canary": ["snapshot"],
      "next": ["some", "other", "args"],
    }}
  ]
}

@auto-it/version-file dependencies

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

FAQs

What is @auto-it/version-file?

For managing versions in a repository that maintains the version primarily in a flat file. Agnostic to the primary lang... Visit Snyk Advisor to see a full health score report for @auto-it/version-file, including popularity, security, maintenance & community analysis.

Is @auto-it/version-file popular?

The npm package @auto-it/version-file receives a total of 65,889 weekly downloads. As such, @auto-it/version-file popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @auto-it/version-file well maintained?

We found that @auto-it/version-file 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/version-file safe to use?

The npm package @auto-it/version-file 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 21 November-2024, at 22:46 (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