Security News
Introducing the Socket Python SDK
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
@release-it/bumper
Advanced tools
This plugin reads and/or writes version/manifest files.
npm install --save-dev @release-it/bumper
In release-it config:
"plugins": {
"@release-it/bumper": {
"in": "composer.json",
"out": "composer.json",
}
}
in
option to read the version from this file in the release-it process.out
option to write the version that was determined by release-it to this file.version
property from/to this file.The version
from the in
file will take precedence over the latest Git tag (and the version
from package.json
if
it exists) in release-it to determine the latest version.
Note that using package.json
as out
file may conflict with the npm plugin in release-it. Remove it from the out
file(s), or use
--npm.allowSameVersion
.
The supported file types are:
Type | Extension(s) | Mime-type |
---|---|---|
JSON | .json | application/json |
YAML | .yaml or .yml | text/yaml or application-x-yaml |
TOML | .toml | text/toml or application/toml |
INI | .ini | text/x-properties |
TEXT | .txt | text/* |
Explicitly providing the (mime) type
takes precedence over the file extension.
The fallback type is text
if the file extension and/or type
is not known (e.g. index.php
).
"plugins": {
"@release-it/bumper": {
"in": {
"file": "VERSION",
"type": "text/plain"
},
"out": {
"file": "VERSION",
"type": "text/plain"
}
}
}
To replace all occurences of the current version with the new version in any text file:
"plugins": {
"@release-it/bumper": {
"out": {
"file": "file.php",
"type": "text/php"
}
}
}
:warning: the operation is a search-and-replace; if the current version is not found in the file, the new version cannot be written out.
To instead always consume the entire file, that is, the whole and only content of the file is the version number, set consumeWholeFile: true
for the out
option:
"plugins": {
"@release-it/bumper": {
"out": {
"file": "VERSION",
"type": "text/plain",
"consumeWholeFile": true
}
}
}
The version number is then written to the output file, overwriting it completely instead of a search-and-replace.
:bulb: Setting consumeWholeFile: true
precludes the use of prefixes, such as v1.0.1
in the output file.
The out
option can also be an array of files:
"plugins": {
"@release-it/bumper": {
"out": ["manifest.json", "bower.json"]
}
}
The out
option is parsed with fast-glob, so glob patterns can be used to match
files to write to:
"plugins": {
"@release-it/bumper": {
"out": "dist/*.json"
}
}
The path
option (default: "version"
) can be used to change a different property. The following example will set the
current.version
property to the new version in manifest.json
:
"plugins": {
"@release-it/bumper": {
"out": {
"file": "manifest.json",
"path": "current.version"
}
}
}
Multiple paths can be provided using an array.
The versionPrefix
option (default: ''
) can be used in cases where you'd like to maintain a specific prefix for your version number (for example, in package.json
where you might want versions like ^1.0.0
). This will prepend the specified prefix to the bumped version:
"plugins": {
"@release-it/bumper": {
"out": {
"file": "package.json",
"path": "version",
"prefix": "^"
}
}
}
With the above configuration, if release-it determines the new version to be 1.0.0
, it'll be saved as ^1.0.0
in the targeted file.
Options for this plugin can be set from the command line. Some examples:
release-it --plugins.@release-it/bumper.in=composer.json
release-it --plugins.@release-it/bumper.out=composer.json --plugins.@release-it/bumper.out=manifest.json
no-
.'
) such as --'deep.key=value'
or '--deep.key=value'
Depending on your shell or OS this may differ.
FAQs
Version read/write plugin for release-it
The npm package @release-it/bumper receives a total of 20,200 weekly downloads. As such, @release-it/bumper popularity was classified as popular.
We found that @release-it/bumper demonstrated a healthy version release cadence and project activity because the last version was released less than 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
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.