-
Notifications
You must be signed in to change notification settings - Fork 116
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add RELEASE.md describing the release process
- Loading branch information
1 parent
67d2999
commit ac4ce14
Showing
1 changed file
with
19 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
How to Release to NPM | ||
===================== | ||
|
||
Drakov uses [release-it](https://github.com/release-it/release-it) to perform the release process. | ||
|
||
* You must have authenticated to NPM using `npm login` | ||
* Ensure one is not on any Corporate VPN or using Proxies that might get in the way... | ||
* Have `GITHUB_TOKEN` environment variable set to a Github OAUth token that can be used to perform Github functions (tagging, creating releases etc) | ||
* You will be prompted for a One-Time Passphrase during the release if your NPM account has that setup | ||
|
||
Official Major Release | ||
---------------------- | ||
``` | ||
npm run release -- major | ||
``` | ||
|
||
One can use `minor` and `patch` as well for the release versioning. `--dry-run` can be useful to see what is being done without doing anything. | ||
|
||
(anything after the `--` is `release-it` arguments, see documentation) |