Skip to content

Commit 0debed2

Browse files
authored
DOC -- [root] release and prerelease instruction (#1729)
1 parent 48207ac commit 0debed2

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,29 @@ While FCL itself is a concept and standard, FCL JS is the javascript implementat
3737
npm i
3838
npm run build
3939
```
40+
41+
### Release
42+
Packages stable versions releases are controlled by [changesets](https://github.com/changesets/changesets) from the `master` branch
43+
44+
#### Prerelease(alpha)
45+
In order to create an `alpha` (pre-)release
46+
- create a branch with `release-<VERSION>` as a branch name
47+
- run:
48+
```
49+
npm run changeset pre enter alpha
50+
npm run changeset version
51+
npm run changeset publish
52+
```
53+
54+
*NOTE: you need to have an npm account and be a member of [OnFlow organization](https://www.npmjs.com/org/onflow)*
55+
56+
`changeset` commands should preferably be run from the `release` branch and not from feature branches in order to avoid merge conflicts with other feature branches
57+
when the release is ready to be published as stable run from the release branch
58+
```
59+
npm run changeset pre exit
60+
```
61+
and merge `release-<VERSION>` branch to `master`
62+
4063
### Installation
4164

4265
To use the FCL JS in your application, install using **yarn** or **npm**

0 commit comments

Comments
 (0)