-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
README.md: added some basic release strategies for node
It appears the release strategies for node's npm is a bit of a problem. Hence, let's start from customers' instruction. This patch adds some basic release strategies for node in README.md. Co-authored-by: Shuralyov, Jean <[email protected]> Co-authored-by: Galyna, Cory <[email protected]> Co-authored-by: (Holloway) Chew, Kean Ho <[email protected]> Signed-off-by: (Holloway) Chew, Kean Ho <[email protected]>
- Loading branch information
1 parent
8145070
commit b2f0743
Showing
1 changed file
with
60 additions
and
3 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 |
---|---|---|
|
@@ -34,17 +34,74 @@ This library supports multiple programming languages for the same dataset. | |
Hence, in order to use it, please import based on your deployed programming | ||
language: | ||
|
||
|
||
|
||
### Javascript Ecosystems | ||
|
||
To use `hestiaERROR` library in your Javascript|Typescript project, you may use | ||
the following methods for integrations: | ||
|
||
|
||
#### Git Release Branches (Recommended) | ||
|
||
It's highly recommended to use `git` release branches inside your `package.json` | ||
dependencies list. This is to avoid the registry configurations problem | ||
involving `npm`: | ||
|
||
``` | ||
{ | ||
"dependencies": { | ||
... | ||
"@chewkeanho/hestiaERROR": "git+ssh://[email protected]/chewkeanho/hestiaERROR.git#[VERSION]_js" | ||
... | ||
} | ||
} | ||
``` | ||
|
||
For always latest release, the `latest` version tag can be used. Example: | ||
|
||
``` | ||
{ | ||
... | ||
"dependencies": { | ||
... | ||
"@chewkeanho/hestiaERROR": "git+ssh://[email protected]/chewkeanho/hestiaERROR.git#latest_js" | ||
... | ||
} | ||
... | ||
} | ||
``` | ||
|
||
|
||
#### NPM | ||
|
||
> **NOTE** | ||
> | ||
> To be updated. | ||
|
||
|
||
### Javascript Ecosystems | ||
### `Git` | ||
|
||
#### Git Release Branches (Recommended) | ||
To source using `git`, simpley execute the following instructions: | ||
|
||
``` | ||
git clone --single-branch --branch [BRANCH_VERSION]_git https://github.com/ChewKeanHo/hestiaERROR.git | ||
``` | ||
|
||
For always latest release, use the `main` branch. Example: | ||
|
||
``` | ||
git clone --single-branch --branch `main` https://github.com/ChewKeanHo/hestiaERROR.git | ||
``` | ||
|
||
> **NOTE** | ||
> | ||
> 1. Branches like `next` and `experimental` are for package maintainers and | ||
> development. Only use it at your own risk. | ||
> 2. `next` branch simply means the next release version. | ||
> 3. `experimental` is for maintainers' development. | ||
#### NPM | ||
|
||
|
||
|
||
|