Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update branch paths and targets for develop, main and docs branches - (main) #1503

Merged
merged 3 commits into from
Jan 31, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ aliases:
- &deploy_production_filters
filters:
branches:
only: v2-web3-onboard
only: main

- &deploy_staging_filters
filters:
branches:
only: v2-web3-onboard-develop
only: develop

- &test_package_version_for_alpha_tag_break_false
run:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ name: Deploy documentation to Pages
on:
# Runs on pushes targeting the default branch
push:
branches: ["docs-main"]
branches: ["docs"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pr-status-checks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
workflow_dispatch:
pull_request:
branches:
- v2-web3-onboard-develop
- develop

jobs:
checks:
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ If you would like to test out the current functionality of V2 in a small browser

- Clone the repo: `git clone git@github.com:blocknative/onboard.git`
- Change in to the onboard directory: `cd onboard`
- Checkout the V2 feature branch: `git checkout v2-web3-onboard`
- Checkout the V2 feature branch: `git checkout main`
- Install the dependencies: `yarn` (if running a M1 mac - `yarn install-m1-mac`)
- Run all packages in dev mode: `yarn dev`
- To view the demo app in the browser after running the above steps navigate to [http://localhost:8080](http://localhost:8080)
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ Run `yarn build` and confirm no errors present from the proposed changes.

Confirm vercel build within PR builds without error and check instance deployment for accuracy.

PR should target branch the main develop branch - [v2-web3-onboard-develop](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard-develop).
PR should target branch the main develop branch - [develop](/~https://github.com/blocknative/web3-onboard/tree/develop).
2 changes: 1 addition & 1 deletion docs/src/routes/docs/[...1]overview/[...1]introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Test out the current functionality of web3-onboard in a small browser demo:

- Clone the repo: `git clone git@github.com:blocknative/web3-onboard.git`
- Change it to the onboard directory: `cd web3-onboard`
- Checkout the main web3-onboard branch: `git checkout v2-web3-onboard`
- Checkout the main web3-onboard branch: `git checkout main`
- Install the dependencies: `yarn` (if running a M1 mac - `yarn install-m1-mac`)
- Run all packages in dev mode: `yarn dev`
- [View demo app in the browser](http://localhost:8080/)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ After making changes within a web3-onboard package you will want to bump the ver
We use both semantic and `alpha` versioning for publishing and testing packages prior to official release. This means if you do not see an `-alpha.x` tag on the version of the package you made changes in you will need to not only bump the version but also add an alpha flag followed by an alpha version number starting at 1 (ex. `-alpha.1`).

Example : Adding a new injected wallet to the `injected` package -
[Injected Package.json](/~https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/packages/injected/package.json#L3) changes : `"version": "2.2.4",` --> `"version": "2.3.0-alpha.1",`
[Injected Package.json](/~https://github.com/blocknative/web3-onboard/blob/develop/packages/injected/package.json#L3) changes : `"version": "2.2.4",` --> `"version": "2.3.0-alpha.1",`

Example 2 : Bug fix within the `core` package -
[Core package.json](/~https://github.com/blocknative/web3-onboard/blob/8531a73d69365f7d584320f1c4b97a5d90f1c34e/packages/core/package.json#L3) changes: `"version": "2.9.1-alpha.1",` --> `"version": "2.9.1-alpha.2",`
Expand All @@ -44,7 +44,7 @@ If you cannot write the code yourself to add a new wallet, then go ahead and cre

### Documentation contributions

In order to contribute to the docs, you'll have to create a PR on the [v2-web3-onboard-develop branch](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard-develop). If you contribute code, you should definitely document it appropriately. We highly encourage the community to improve web3-onboard docs, if you have any questions don't hesitate to reach out.
In order to contribute to the docs, you'll have to create a PR on the [develop branch](/~https://github.com/blocknative/web3-onboard/tree/develop). If you contribute code, you should definitely document it appropriately. We highly encourage the community to improve web3-onboard docs, if you have any questions don't hesitate to reach out.

## Feedback

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you have bnc-onboard installed, you will need to install web3-onboard instead
3. Make use of our API actions like `await onboard.connectWallet()` to allow a user to connect their wallets.

For a full code overview of the upgrade process using the React Hooks package please see [this PR](/~https://github.com/blocknative/react-demo/pull/160/files) with special attention to the `App.js` and `services.js` files.
To help you get started quickly we’ve put together [a set of examples across multiple frameworks that includes the above-mentioned steps](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard-develop/examples).
To help you get started quickly we’ve put together [a set of examples across multiple frameworks that includes the above-mentioned steps](/~https://github.com/blocknative/web3-onboard/tree/develop/examples).

### Package Upgrade - Modularization

Expand Down
18 changes: 9 additions & 9 deletions docs/src/routes/docs/[...3]modules/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,13 @@ npm install @web3-onboard/coinbase @web3-onboard/fortmatic @web3-onboard/gnosis
Checkout our full library of quick start examples for connecting and interacting with EVM based wallets

- **[React](/~https://github.com/blocknative/react-demo)**
- **[Nextjs 13](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs-13)**
- **[Nextjs](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs)**
- **[Svelte](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/packages/demo)**
- **[SvelteKit](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-sveltekit)**
- **[Vite/React](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vite-react)**
- **[Vue](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs)**
- **[Vue2](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs-v2)**
- **[Nextjs 13](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs-13)**
- **[Nextjs](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs)**
- **[Svelte](/~https://github.com/blocknative/web3-onboard/tree/main/packages/demo)**
- **[SvelteKit](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-sveltekit)**
- **[Vite/React](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-vite-react)**
- **[Vue](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs)**
- **[Vue2](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs-v2)**

## Initialization

Expand Down Expand Up @@ -178,7 +178,7 @@ type Locale = string // eg 'en', 'es'
type i18nOptions = Record<Locale, i18n>
```

To see a list of all of the text values that can be internationalized or replaced, check out the [default en file](/~https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/packages/core/src/i18n/en.json).
To see a list of all of the text values that can be internationalized or replaced, check out the [default en file](/~https://github.com/blocknative/web3-onboard/blob/develop/packages/core/src/i18n/en.json).
Onboard is using the [ICU syntax](https://formatjs.io/docs/core-concepts/icu-syntax/) for formatting under the hood.

**`theme`**
Expand Down Expand Up @@ -258,7 +258,7 @@ Currently notifications are positioned in the same location as the account cente
The `transactionHandler` can react off any property of the Ethereum TransactionData returned to the callback from the event (see console.log in example init). In turn, it can return a Custom `Notification` object to define the verbiage, styling, or add functionality:

- `Notification.message` - to completely customize the message shown
- `Notification.eventCode` - handle codes in your own way - see codes here under the notify prop [default en file here](/~https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/packages/core/src/i18n/en.json)
- `Notification.eventCode` - handle codes in your own way - see codes here under the notify prop [default en file here](/~https://github.com/blocknative/web3-onboard/blob/develop/packages/core/src/i18n/en.json)
- `Notification.type` - icon type displayed (see `NotificationType` below for options)
- `Notification.autoDismiss` - time (in ms) after which the notification will be dismissed. If set to `0` the notification will remain on screen until the user dismisses the notification, refreshes the page or navigates away from the site with the notifications
- `Notification.link` - add link to the transaction hash. For instance, a link to the transaction on etherscan
Expand Down
16 changes: 8 additions & 8 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a href="https://onboard.blocknative.com/">
<img alt="Web3-Onboard UI Components" src="/~https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/core.svg?raw=true" />
<img alt="Web3-Onboard UI Components" src="/~https://github.com/blocknative/web3-onboard/blob/develop/assets/core.svg?raw=true" />
</a>

# @web3-onboard/core
Expand All @@ -11,13 +11,13 @@ This is the core package that contains all of the UI and logic to be able to sea
Checkout our full library of quick start examples for connecting and interacting with EVM based wallets

- **[React](/~https://github.com/blocknative/react-demo)**
- **[Nextjs 13](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs-13)**
- **[Nextjs](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-nextjs)**
- **[Svelte](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/packages/demo)**
- **[SvelteKit](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-sveltekit)**
- **[Vite/React](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vite-react)**
- **[Vue](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs)**
- **[Vue2](/~https://github.com/blocknative/web3-onboard/tree/v2-web3-onboard/examples/with-vuejs-v2)**
- **[Nextjs 13](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs-13)**
- **[Nextjs](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-nextjs)**
- **[Svelte](/~https://github.com/blocknative/web3-onboard/tree/main/packages/demo)**
- **[SvelteKit](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-sveltekit)**
- **[Vite/React](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-vite-react)**
- **[Vue](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs)**
- **[Vue2](/~https://github.com/blocknative/web3-onboard/tree/main/examples/with-vuejs-v2)**

## Installation

Expand Down
2 changes: 1 addition & 1 deletion packages/react/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a href="https://onboard.blocknative.com/">
<img alt="Web3-Onboard UI Components" src="/~https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/core.svg?raw=true" />
<img alt="Web3-Onboard UI Components" src="/~https://github.com/blocknative/web3-onboard/blob/develop/assets/core.svg?raw=true" />
</a>

# @web3-onboard/react
Expand Down
2 changes: 1 addition & 1 deletion packages/transaction-preview/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# @web3-onboard/transaction-preview

## A modular UI for previewing a single or set of unsigned Ethereum transactions.
![Transaction Preview Flow](/~https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/transaction-preview.gif?raw=true "Transaction Preview Flow")
![Transaction Preview Flow](/~https://github.com/blocknative/web3-onboard/blob/develop/assets/transaction-preview.gif?raw=true "Transaction Preview Flow")

#### Full Transaction Preview package documentation available [here](https://onboard.blocknative.com/docs/packages/transaction-preview)

Expand Down
2 changes: 1 addition & 1 deletion packages/vue/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a href="https://onboard.blocknative.com/">
<img alt="Web3-Onboard UI Components" src="/~https://github.com/blocknative/web3-onboard/blob/v2-web3-onboard-develop/assets/core.svg?raw=true" />
<img alt="Web3-Onboard UI Components" src="/~https://github.com/blocknative/web3-onboard/blob/develop/assets/core.svg?raw=true" />
</a>

# @web3-onboard/vue
Expand Down