@twyr/announce
Advanced tools
CLI Tool and NPM Library for announcing a release on Github / Gitlab / etc. and on NPM
| Category | Status |
|---|---|
| Conventions |   |
| Code Stats |   |
| Security |    |
| Development |   |
| Issues |   |
| Pull Requests |   |
| Release Status |    |
| Publish Status |    |
Most node.js projects follow a fairly simple set of steps during development - bump the (semantic) version for the next release, commit code, author a changelog, tag/release on Github/Gitlab (with release notes), and publish to the NPM Registry.
While there are several tools that help with each of these steps, they fall into one of two categories - they either perform only one of the steps, or they try to do everything and end up being extremely complex. A good example of the first category of tool is npm-version, which takes responsibility only for bumping up the versions, and nothing else. On the other hand, tools such as semantic-release provide functionality (via plugins) to push not only to NPM, but also several other registries/endpoints - see semantic-release plugins for example.
For the usual projects, neither of these categories of tools is "exactly right" - they provide either too little, or too much, functionality. The Announce CLI/Module tries to fill in that "sweet spot" - providing exactly the functionality required.
The Twy'r Announce tool caters to the following development/release workflow:
Assuming that node.js and npm have already been installed on the system, Announce can be installed via the following commands:
| Install Type | Command |
|---|---|
| Local | npm install @twyr/announce --save-dev |
| Global | npm install @twyr/announce --global |
The list of commands, and the options each command supports, can be accessed from the terminal by:
| Install Type | Command |
|---|---|
| Local | npx announce -h |
| Global | announce -h |
The Announce CLI list of commands, and a brief description of each, is given below:
| Announce Command | Usage | Description |
|---|---|---|
| Prepare | announce prepare | Increments the version as necessary. See Prepare Command for details |
| Release | announce release | Generate CHANGELOG, tag the code, and release to GitHub/GitLab. See Release Command for details |
| Publish | announce publish | Publish a GitHub/GitLab Release to npm. See Publish Command for details |
See command specific documentation for further information on how to execute each command, the command-line, options relevant to that command, etc.
Assuming that node.js and npm have already been installed on the system, Announce can be installed
via the following command: npm install @twyr/announce --save-dev
Once installed, the module may be loaded using:
const announce = require('@twyr/announce);
See command specific documentation for information regarding each command, the options it takes, etc.
All contributors to this project are expected to adhere to the Code of Conduct specified.
Details on getting the code, setting up the development environment, and instructions on how to extend/build/test the code are detailed in the Contribution Guide
This project owes its existence to these wonderful people (emoji key):
 Vish Desai |
This project follows the all-contributors specification. Contributions of any kind are welcome!
This project is licensed under the MIT +no-false-attribs license. You may get a copy of the license by following the link, or at LICENSE.md
| Command | Category | Alternatives on NPM |
|---|---|---|
| Prepare | Semantic Versioning | npm-version |
| Release | Changelog Management | changelog |
| Release | Tagging & Releasing | release |
| Publish | Registry (NPM, et al) Publishing | publish |
FAQs
CLI Tool and NPM Library for announcing a release on Github / Gitlab / etc. and on NPM
We found that @twyr/announce 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
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.