https://github.com/livingdocsio/release-tools
CLI Tools for Handling a Release
https://github.com/livingdocsio/release-tools
Last synced: 7 months ago
JSON representation
CLI Tools for Handling a Release
- Host: GitHub
- URL: https://github.com/livingdocsio/release-tools
- Owner: livingdocsIO
- Created: 2017-07-06T12:21:39.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T13:31:21.000Z (over 1 year ago)
- Last Synced: 2025-10-11T21:48:37.429Z (8 months ago)
- Language: JavaScript
- Homepage:
- Size: 3.28 MB
- Stars: 0
- Watchers: 8
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Release Tools
[](https://greenkeeper.io/)
The release tools are a bunch of command line tools to maintain a release. These tools are usually used by a release manager.
## Usage
#### Preconditions
Have [`npx`](https://www.npmjs.com/package/npx) installed with `npm install -g npx`
#### List of available commands
`npx release-tools`
#### Create Release Branch
**Introduction**
When you want to manage a product with different releases and support old version with patches, you can not just use semver on master. You also have to work with release branches to support old versions. A more detailed explanation with an example can be found [here](./doc/how-to-handle-a-product-release-on-github.md)
**Commands**
* Help: `npx @livingdocs/release-tools@ create-release-branch`
* Command (simple example): `npx @livingdocs/release-tools@ create-release-branch --base-tag=v1.0.1 --release-branch-name=release-2017-10 --npm-token=`
## Examples
- [How to Handle a Customer Release on Github](./doc/how-to-handle-a-release-on-github.md)
## Run the tests
```bash
npm test
```
## Test the release tools locally
Change the directory to a repository you want to test the release tools with (e.g. livingdocs-server), the release tools will be executed in the context of the repository you are in. Both repositories should be in the same parent directory. Then run the following command:
```bash
node ../release-tools/bin/cmd.js create-release-branch \
--repo=repoName \
--base-tag=validVersion \
--release-branch-name=test-release \
--npm-token=validNPMToken
```
A validVersion is a tag that exists in the repository you are in and fulfils semver constraints:
- latest version of minor bump (e.g. 1.2.latest)
- newer minor or major version exist (e.g. 1.3.0 or 2.0.0 exist)
## Copyright
Copyright (c) 2018 Livingdocs AG, all rights reserved
It is not permitted to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of this Software ('release-tools'), except when explicitly stated otherwise by Livingdocs AG.