Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ukayani/releaseme
Node module release inspired by sbt-release
https://github.com/ukayani/releaseme
Last synced: about 6 hours ago
JSON representation
Node module release inspired by sbt-release
- Host: GitHub
- URL: https://github.com/ukayani/releaseme
- Owner: ukayani
- License: mit
- Created: 2017-04-14T20:32:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-12T03:45:20.000Z (about 7 years ago)
- Last Synced: 2024-11-09T11:19:20.876Z (9 days ago)
- Language: JavaScript
- Size: 36.1 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Releaseme
A release tool inspired by [sbt-release](https://github.com/sbt/sbt-release) for node projects.
# How it works
A typical release process involves running tests, updating project version, tagging the release and publishing the artifact.
Although some steps in this process are common amongst projects, some projects may require a custom release process.
With `releaseme` you are able to set up a custom release process for your project using a combination of built-in steps and
custom step definitions.
The steps will execute in serial and if any step fails, the release process fails.
# Installation
```bash
$ npm install -g releaseme
```
# Usage
In the root of your project run `releaseme`.
By default, `releaseme` will increment the current project version with a `patch` increment using the [Default Release Process](#default-release-process).
You can specify the type of increment via the `type` argument with one of the following values: [`major`, `minor`, `patch`]
If you wish to specify the exact release version you can do so via the `--release-version` arg.
```bash
Usage: releaseme [options] [type]
Releases your node module. Use [type] to specify: [major, minor, patch]
Options:
-h, --help output usage information
-V, --version output the version number
-c, --release-version The version to release
-n, --next-version The next version for release (snapshot)
```
# Default Release Process
The default release process involves the following steps:
1. **checkStatus** - Check if the git working directory is clean. If there are any unstaged/staged changes the process will fail.
2. **test** - Runs `npm test` on your project
3. **setReleaseVersion** - Updates the `package.json` with the release version
4. **commitReleaseVersion** - Commits the release version (package.json)
5. **tagRelease** - Creates a git annotated tag with the release version
6. **publish** - Runs `npm publish` on your project to publish your artifact to npm.
7. **setNextVersion** - Sets the next development version in `package.json` for your project with a `SNAPSHOT` suffix.
8. **commitNextVersion** - Commits this new snapshot version
9. **pushChanges** - Pushes all changes git remote origin.
# Custom Release Process
To set up a custom release process, you can define an array of steps in your `package.json` via the
`releaseme.steps` field.
You can use built-in steps listed in [Default Release](#default-release-process) or use custom steps.
### Custom Step
To set up custom steps you must define the step as a `script` in your `package.json`.
You can then use the name of the script as a step in your release.
**Example package.json with custom release with linting**
```json
{
"name": "my-module",
...
"scripts": {
"lint": "gulp lint",
"test": "gulp test"
},
"releaseme": {
"steps": [
"checkStatus",
"lint",
"test",
"setReleaseVersion",
"commitReleaseVersion",
"tagRelease",
"publish",
"setNextVersion",
"commitNextVersion",
"pushChanges"
]
},
...
}
```
The example above adds a script called lint which runs `gulp lint`. We then use this script as a step in our release steps after `checkStatus`
### Custom tag prefix
If you have a convention for prefixing your release tags such as `v0.1.0` you can set a prefix via the `tagPrefix` property on `releaseme`:
**Example package.json with custom tag prefix**
```json
{
"name": "my-module",
...
"scripts": {
"lint": "gulp lint",
"test": "gulp test"
},
"releaseme": {
"tagPrefix": "v"
"steps": [
...
]
},
...
}
```