Skip to content

Commit

Permalink
Merge branch 'onflow:master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
mordochi authored Oct 18, 2023
2 parents 41656b8 + e0d0d14 commit a2dfa14
Show file tree
Hide file tree
Showing 128 changed files with 12,603 additions and 31,103 deletions.
5 changes: 5 additions & 0 deletions .changeset/six-cherries-clap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@onflow/fcl": minor
---

Send suggested features to discovery
5 changes: 5 additions & 0 deletions .changeset/slow-peaches-vanish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@onflow/fcl": minor
---

Use localStorage as default & export LOCAL_STORAGE/SESSION_STORAGE as helpers for fcl.storage.default configuration key
1 change: 0 additions & 1 deletion .github/workflows/integrate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ name: FLOW-JS-SDK Continuous Integration

on:
pull_request:
branches: [master]

jobs:
test_pull_request:
Expand Down
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,29 @@ While FCL itself is a concept and standard, FCL JS is the javascript implementat
npm i
npm run build
```

### Release
Packages stable versions releases are controlled by [changesets](https://github.com/changesets/changesets) from the `master` branch

#### Prerelease(alpha)
In order to create an `alpha` (pre-)release
- create a branch with `release-<VERSION>` as a branch name
- run:
```
npm run changeset pre enter alpha
npm run changeset version
npm run changeset publish
```

*NOTE: you need to have an npm account and be a member of [OnFlow organization](https://www.npmjs.com/org/onflow)*

`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
when the release is ready to be published as stable run from the release branch
```
npm run changeset pre exit
```
and merge `release-<VERSION>` branch to `master`

### Installation

To use the FCL JS in your application, install using **yarn** or **npm**
Expand Down Expand Up @@ -150,6 +173,8 @@ const newUser: CurrentUser = {
}
```

For all type definitions available, see [this file](./packages/typedefs/src/index.js)

## Next Steps

See the [Flow App Quick Start](https://developers.flow.com/tutorials/flow-app-quickstart).
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ If you care about making a difference, please follow the guidelines below.

# **Guidelines For Responsible Disclosure**

We ask that all researchers adhere to these guidelines [here](https://docs.onflow.org/bounties/responsible-disclosure/).
We ask that all researchers adhere to these guidelines [here](https://flow.com/flow-responsible-disclosure).
3 changes: 2 additions & 1 deletion lerna.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"packages": ["packages/*"],
"version": "independent"
"version": "independent",
"useWorkspaces": true
}
Loading

0 comments on commit a2dfa14

Please sign in to comment.