Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
opbeat-release-tracker
Advanced tools
A simple module to track a release on Opbeat.
Please note that release tracking is built in to the official Opbeat node.js module.
npm install opbeat-release-tracker
The module exposes a single init function:
var trackRelease = require('opbeat-release-tracker')({ ... })
The init function takes an optional options hash with the following properties:
appId
- The Opbeat app id (falls back to the OPBEAT_APP_ID
environment variable)organizationId
- The Opbeat organization id (falls back to the
OPBEAT_ORGANIZATION_ID
environment variable)secretToken
- The Opbeat secret token (falls back to the
OPBEAT_SECRET_ID
environment variable)auto
- If true
(default) opbeat-release-tracker will try to
auto-detect the git rev and/or branch if not specifically given. Set
to false
to disable this behaviorcwd
- Directory where to auto-detect git rev or branch if those are
not provided when tracking a release (falls back to process.cwd()
)userAgent
- Set if you wish to override the default HTTP User-Agent
(this makes sense if you use the opbeat-release-tracker module as a
submodule to another module)The init function returns a release tracker function which can be called to track a specific release:
trackRelease([options][, callback])
The options
object is optional but can be used to specify the
following properties:
rev
- Git commit hash of the releasebranch
- Git branch of the deployed releasecwd
- Directory where to auto-detect git rev or branch if those are
not provided (will override the cwd
given upon initialization and
fall back to process.cwd()
if neither is provided)status
- Either completed
(default) or machine-completed
machine
- Name of the machine where the release was deployed (only
valid if status
is set to machine-completed
)The callback
function is optional and will be called once the release
have been tracked. If an error occurred while tracking the release the
callback will be called with the Error object as the first argument.
Note that if an error occurres and no callback have been provided the
error is not thrown.
For more information about the Opbeat release API, check out the official API documentation.
MIT
FAQs
Stand-alone release tracker for Opbeat
The npm package opbeat-release-tracker receives a total of 203 weekly downloads. As such, opbeat-release-tracker popularity was classified as not popular.
We found that opbeat-release-tracker 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
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.