-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Benji Visser <[email protected]>
- Loading branch information
Showing
1 changed file
with
16 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,16 @@ | ||
# Contributing | ||
|
||
### Publishing on Npm | ||
|
||
We manage _what_ gets merged _when_ using the pull request labels `release` and `prerelease`. | ||
|
||
When the `prerelease` label is added to a pull request: | ||
|
||
- the version in the package.json is verified, asserting that it is greater than the version in the main branch and includes a prerelease suffix (_e.g 1.2.3-rc.1_) | ||
- the package is published to NPM with the `--next` tag. The next tag is how alpha and beta package versions are published to NPM. When a developer runs `npm install @vesselapi/integrations` versions with the next tag are ignored -- unless they are specifically specified `npm install @vesselapi/[email protected]`. | ||
|
||
When the `release` label is added to a pull request: | ||
|
||
- the version in the package.json is verified, asserting that it is greater than the version in the main branch and does not include a prerelease suffix | ||
|
||
When no release label is provided github actions verifies that the version has not changed so versions of the package are not published erroneously. |