https://github.com/knorcedger/rapid-release
Helps automate the required steps to create a new release
https://github.com/knorcedger/rapid-release
github-releases npm-publish release release-automation
Last synced: about 1 year ago
JSON representation
Helps automate the required steps to create a new release
- Host: GitHub
- URL: https://github.com/knorcedger/rapid-release
- Owner: Knorcedger
- Created: 2018-05-22T17:41:51.000Z (almost 8 years ago)
- Default Branch: develop
- Last Pushed: 2018-06-14T16:40:48.000Z (almost 8 years ago)
- Last Synced: 2025-03-16T03:47:03.019Z (about 1 year ago)
- Topics: github-releases, npm-publish, release, release-automation
- Language: JavaScript
- Homepage:
- Size: 18.6 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Rapid Release
Rapid Release is a tool to help automate the required steps to create a new release of your app.
## Usage
```
npx rapid-release VERSION
```
VERSION can be any of major, minor, patch, premajor, preminor, prepatch, prerelease, 1.2.3 (uses [npm version](https://docs.npmjs.com/cli/version))
It makes a few assumptions about the project, so be sure those things are true with your project.
The main goal is to marge the `develop` branch into `master`, push everything and add the required tags. The main assumption is that you follow gitflow and you have a `develop` (or any branch name that contains the string `dev`) that you want to merge into `master` and release.
It also assumes that you want `master` and `develop` branch to have the exact same commits after the release is done, which is a good practise.
## Actions
Following are the actions that Rapid Release executes, in the order those are executed.
- Check if the current branch has the string `dev` in it's name
- `npm test` run tests or skip them using flag `-s`
- `git pull` make sure we have all changes
- `npm version VERSION` VERSION is the version you specified
- `git push` push the new commit that npm created
- `git push --follow-tags` push the tag that npm created
- `git checkout master` go to `master` branch
- `git pull` make sure we have latest code
- `git merge DEV_BRANCH` merge the branch we started in, to `master`
- `git push` push the new release code
- `npm publish` only if you used the `-p` flag
- `git checkout DEV_BRANCH` go back to the branch we started at
## Available flags
`-s` or `--skip-tests` to skip running the tests (`npm test`)
`-p` or `--npm-publish` to publish on npm (`npm publish`)