Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mogelbrod/await-release
CLI (and node module) which waits until a new NPM package version becomes available
https://github.com/mogelbrod/await-release
cli npm npm-package
Last synced: about 1 month ago
JSON representation
CLI (and node module) which waits until a new NPM package version becomes available
- Host: GitHub
- URL: https://github.com/mogelbrod/await-release
- Owner: mogelbrod
- License: mit
- Created: 2020-05-25T16:33:12.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-08-31T19:44:08.000Z (over 3 years ago)
- Last Synced: 2024-11-29T00:47:39.774Z (about 2 months ago)
- Topics: cli, npm, npm-package
- Language: JavaScript
- Homepage:
- Size: 76.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# await-release
CLI (and node module) which polls the NPM registry until a new package version
becomes available. The CLI will exit once a matching release is found, allowing
subsequent commands to run.
## Features
- [x] Supports private NPM registries (if `npm` can access it, so should this package)
- [x] `--exec 'npm install %s'` to inject and run commands on release
- [x] `--install` flag to automatically run `npm install $package` on release
- [ ] `--update` flag to automatically run `npm update $package` on release
- [ ] `--daemon` to keep listening for new releases (works with `--exec`)
## Installation
```sh
npm install -g await-release
```
## Usage
```sh
await-release [options] [package2@version...]
```
Package identifiers may optionally include:
- scope (@org/pkg)
- semver version string (pkg@16, [email protected], etc.)
### Options
```
-i, --install execute 'npm install' on release
-e, --exec execute shell command on release (interpolates %p, %s, %t, %v)
-o, --output output format (default/verbose/none/json)
-g, --grace accept versions released up to X seconds before invocation (default: 10)
-t, --timeout exit if no release matches after X seconds (default: 0)
-d, --delay time between polling requests (default: 2)
```
### Using `--exec`
Other processes can be invoked when a release is discovered using the `--exec`
option. The provided string will be executed within a basic shell environment
after interpolation of the following placeholders:
- `%p`: package name (`my-package`, `@scope/package`, etc.)
- `%s`: package name and version (`[email protected]`, `@scope/[email protected]`, etc.)
- `%t`: time of release in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
format (`2020-05-26T22:01:02Z`)
- `%v`: released version (`1.0.1`)
#### Install new version of a dependency when it becomes available
```sh
await-release my-dependency -i
# or via --exec:
await-release my-dependency --exec 'npm install %s'
```
#### Notify when a new package version is released
```sh
await-release package-name --exec "npx -p node-notifier-cli notify -t '%p released %v'"
```