diff --git a/.circleci/config.yml b/.circleci/config.yml index a95659ea3..e559a7cef 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -30,4 +30,4 @@ workflows: - snapshot: filters: branches: - only: master + only: main diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 0c50c488e..fab1b7535 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -2,7 +2,7 @@ name: Docs on: push: branches: - - master + - main jobs: build-and-deploy: diff --git a/.github/workflows/publish-pods.yml b/.github/workflows/publish-pods.yml index ccf3daea1..2ef2e2b6e 100644 --- a/.github/workflows/publish-pods.yml +++ b/.github/workflows/publish-pods.yml @@ -131,7 +131,7 @@ jobs: - Make sure that the Podfile.lock contains latest FlipperKit and Flipper pod versions. - Also make sure that all the dependencies are updated to the latest one. - This is auto-generated by [create-pull-request](https://github.com/peter-evans/create-pull-request) - base: "master" + base: "main" branch-suffix: short-commit-hash labels: automated pr env: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5ea4409c3..23e5262aa 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,7 +2,7 @@ name: Release on: push: branches: - - master + - main paths: - 'desktop/package.json' @@ -38,7 +38,7 @@ jobs: tag_name: ${{ steps.tag-version-commit.outputs.tag }} release_name: ${{ steps.tag-version-commit.outputs.tag }} body: | - See https://github.com/facebook/flipper/blob/master/desktop/static/CHANGELOG.md + See https://github.com/facebook/flipper/blob/main/desktop/static/CHANGELOG.md for full notes. draft: false prerelease: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index df437440c..b5a28e6c5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ when dealing with platform-specific code. We actively welcome your pull requests. -1. Fork the repo and create your branch from `master`. +1. Fork the repo and create your branch from `main`. 2. If you've added code that should be tested, add tests. 3. If you've changed APIs, update the documentation. 4. Ensure the test suite passes. diff --git a/README.md b/README.md index 37a0ae9d5..d9d640041 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@
-
+
diff --git a/desktop/flipper-plugin/src/data-source/README.md b/desktop/flipper-plugin/src/data-source/README.md
index b8002a9af..60ac0d2c9 100644
--- a/desktop/flipper-plugin/src/data-source/README.md
+++ b/desktop/flipper-plugin/src/data-source/README.md
@@ -12,7 +12,7 @@ _Library to power streamig data visualisations as used in Facebook's Flipper_
* [Demo sandbox](https://codesandbox.io/s/flipper-datasource-demo-iy0tq)
* [Demo setup recording](https://www.youtube.com/watch?v=stL66GByQU0)
* [In-depth introduction talk, featured at @fwdays, 5-6-2021](https://www.youtube.com/watch?v=WCs09c1B1Lk)
-* [Source code](https://github.com/facebook/flipper/tree/master/desktop/flipper-plugin/src/data-source)
+* [Source code](https://github.com/facebook/flipper/tree/main/desktop/flipper-plugin/src/data-source)
* [Lightning talk using DataSource in Logs view](https://fb.workplace.com/groups/427492358561913/permalink/432720091372473/) [FB-Only]
* [DataSource project plan](https://fb.quip.com/noJDArpLF7Fe) [FB-Only]
* [Demo project](https://www.internalfb.com/code/flipper/src/fbsource/xplat/sonar/facebook/data-source-demo/) [FB-Only]
diff --git a/desktop/flipper-plugin/src/data-source/package.json b/desktop/flipper-plugin/src/data-source/package.json
index 495494336..5e40d5d9f 100644
--- a/desktop/flipper-plugin/src/data-source/package.json
+++ b/desktop/flipper-plugin/src/data-source/package.json
@@ -3,7 +3,7 @@
"version": "0.0.2",
"description": "Library to power streamig data visualisations",
"repository": "https://github.com/facebook/flipper",
- "homepage": "https://github.com/facebook/flipper/blob/master/desktop/flipper-plugin/src/data-source/README.md",
+ "homepage": "https://github.com/facebook/flipper/blob/main/desktop/flipper-plugin/src/data-source/README.md",
"author": "Facebook Inc",
"license": "MIT",
"source": "index.tsx",
diff --git a/desktop/pkg/schemas/plugin-package-v2.json b/desktop/pkg/schemas/plugin-package-v2.json
index c6798930a..ff6079121 100644
--- a/desktop/pkg/schemas/plugin-package-v2.json
+++ b/desktop/pkg/schemas/plugin-package-v2.json
@@ -26,7 +26,7 @@
},
"icon": {
"type": "string",
- "description": "Determines the plugin icon which is displayed in the main sidebar. The list of available icons is static for now and can be found in https://github.com/facebook/flipper/blob/master/desktop/static/icons.json."
+ "description": "Determines the plugin icon which is displayed in the main sidebar. The list of available icons is static for now and can be found in https://github.com/facebook/flipper/blob/main/desktop/static/icons.json."
},
"keywords": {
"description": "This helps people discover your package as it's listed in 'npm search'. To make the plugin discoverable in Flipper, the property must contain \"flipper-plugin\" keyword.",
diff --git a/docs/extending/create-plugin.mdx b/docs/extending/create-plugin.mdx
index 1bfa3d0e5..ba97f08e3 100644
--- a/docs/extending/create-plugin.mdx
+++ b/docs/extending/create-plugin.mdx
@@ -301,8 +301,8 @@ Here, `sendData` is an example of a method that might be implemented by the Flip
An minimal communication demo can be found in our [Sample project]:
-* [Desktop implementation](https://github.com/facebook/flipper/blob/master/desktop/plugins/public/example/index.tsx)
-* [Android implementation](https://github.com/facebook/flipper/blob/master/android/sample/src/debug/java/com/facebook/flipper/plugins/example/ExampleFlipperPlugin.java) / [iOS implementation](https://github.com/facebook/flipper/tree/7bd4f80c2570bebb52af3cf49e45fc6130d6a473/iOS/Plugins/FlipperKitExamplePlugin/FlipperKitExamplePlugin)
+* [Desktop implementation](https://github.com/facebook/flipper/blob/main/desktop/plugins/public/example/index.tsx)
+* [Android implementation](https://github.com/facebook/flipper/blob/main/android/sample/src/debug/java/com/facebook/flipper/plugins/example/ExampleFlipperPlugin.java) / [iOS implementation](https://github.com/facebook/flipper/tree/7bd4f80c2570bebb52af3cf49e45fc6130d6a473/iOS/Plugins/FlipperKitExamplePlugin/FlipperKitExamplePlugin)
## Background Plugins
diff --git a/docs/extending/desktop-plugin-structure.mdx b/docs/extending/desktop-plugin-structure.mdx
index e8e90f233..1a14c151b 100644
--- a/docs/extending/desktop-plugin-structure.mdx
+++ b/docs/extending/desktop-plugin-structure.mdx
@@ -91,7 +91,7 @@ Important attributes of `package.json`:
- `title` Shown in the main sidebar as the human-readable name of the plugin.
-- `icon` Determines the plugin icon which is displayed in the main sidebar. The list of available icons is static for now: https://github.com/facebook/flipper/blob/master/desktop/static/icons.json.
+- `icon` Determines the plugin icon which is displayed in the main sidebar. The list of available icons is static for now: https://github.com/facebook/flipper/blob/main/desktop/static/icons.json.
- `bugs` Specify an email and/or url, where plugin bugs should be reported.
diff --git a/docs/extending/establishing-a-connection.mdx b/docs/extending/establishing-a-connection.mdx
index 6951ebd94..864dcb1bf 100644
--- a/docs/extending/establishing-a-connection.mdx
+++ b/docs/extending/establishing-a-connection.mdx
@@ -72,4 +72,4 @@ For Flipper desktop to work with a given Client type, it needs to be modified to
`destination` field may not be relevant if your `medium` value is more than 1. `medium=1`(default) means Flipper should do certificate exchange by directly putting certificates at `destination` in the sandbox of the app. `medium=2` means Flipper will use Certificate Uploader and Provider to upload certificates and download it on the client side respectively.
-You can see the current implementations in [CertificateProvider.tsx](https://github.com/facebook/flipper/blob/master/desktop/app/src/utils/CertificateProvider.tsx).
+You can see the current implementations in [CertificateProvider.tsx](https://github.com/facebook/flipper/blob/main/desktop/app/src/utils/CertificateProvider.tsx).
diff --git a/docs/extending/flipper-plugin.mdx b/docs/extending/flipper-plugin.mdx
index 5664d34fe..36cf3d569 100644
--- a/docs/extending/flipper-plugin.mdx
+++ b/docs/extending/flipper-plugin.mdx
@@ -976,11 +976,11 @@ See `View > Flipper Style Guide` inside the Flipper application for more details
A set of globally available utilities like opening links, interacting with the clipboard, etc.
Example: `getFlipperLib().writeTextToClipboard("hello from Flipper");
-The full set of utilities can be found [here](https://github.com/facebook/flipper/blob/master/desktop/flipper-plugin/src/plugin/FlipperLib.tsx#L20)
+The full set of utilities can be found [here](https://github.com/facebook/flipper/blob/main/desktop/flipper-plugin/src/plugin/FlipperLib.tsx#L20)
### createTablePlugin
-Utility to create a plugin that consists of a master table and details JSON view with minimal effort. See the [Showing a table](../tutorial/js-table.mdx) tutorial for an example.
+Utility to create a plugin that consists of a main table and details JSON view with minimal effort. See the [Showing a table](../tutorial/js-table.mdx) tutorial for an example.
`createTablePlugin` creates a plugin that handles receiving data from the client and
displaying it in a table. The table handles selection of items, sorting, filtering and rendering a sidebar where more detailed information can be presented about the selected row.
diff --git a/docs/extending/new-clients.mdx b/docs/extending/new-clients.mdx
index aad4c85d2..7f047977c 100644
--- a/docs/extending/new-clients.mdx
+++ b/docs/extending/new-clients.mdx
@@ -7,7 +7,7 @@ In the GitHub repo, you'll find Flipper clients for Android, iOS and C++ code, b
Flipper clients communicate with the Flipper desktop app using JSON RPC messages over an [RSocket](http://rsocket.io/) connection.
-This page documents the API, and you can use [FlipperConnectionManagerImpl.cpp](https://github.com/facebook/flipper/blob/master/xplat/Flipper/FlipperConnectionManagerImpl.cpp) for reference.
+This page documents the API, and you can use [FlipperConnectionManagerImpl.cpp](https://github.com/facebook/flipper/blob/main/xplat/Flipper/FlipperConnectionManagerImpl.cpp) for reference.
## Establishing a connection
Start by connecting to the Flipper server running within the desktop app. Connecting to the server registers your application with Flipper and enables plugins to interact with it. As the Flipper desktop has a different lifecycle than your app and may connect and disconnect at any time it is important that you attempt to reconnect to the Flipper server until it accepts your connection.
@@ -37,7 +37,7 @@ localhost:8088/sonar?os={OS}
**FOREGROUND**: A boolean indicating whether this connection was established with a foreground process. This is a hint to the Flipper desktop app of whether to re-focus on this connection or not. For example `foreground=true`. This parameter is recommended but optional.
-**SDK_VERSION**: A number indicating the latest protocol version this client is compatible with. You can find the current version in our [C++ connection implementation](https://github.com/facebook/flipper/blob/master/xplat/Flipper/FlipperConnectionManagerImpl.cpp#L37). Usually stored as a constant in the client code, this allows protocol changes to be made whilst still preserving connectivity with old clients. When Flipper desktop encounters an old SDK version, it may attempt to communicate using a matching protocol. However, backwards compatibility is not guaranteed and you should strive to update clients on the rare occasion that the protocol version advances.
+**SDK_VERSION**: A number indicating the latest protocol version this client is compatible with. You can find the current version in our [C++ connection implementation](https://github.com/facebook/flipper/blob/main/xplat/Flipper/FlipperConnectionManagerImpl.cpp#L37). Usually stored as a constant in the client code, this allows protocol changes to be made whilst still preserving connectivity with old clients. When Flipper desktop encounters an old SDK version, it may attempt to communicate using a matching protocol. However, backwards compatibility is not guaranteed and you should strive to update clients on the rare occasion that the protocol version advances.
## Responding to messages
diff --git a/docs/extending/public-releases.mdx b/docs/extending/public-releases.mdx
index ad4acc838..493bc29a5 100644
--- a/docs/extending/public-releases.mdx
+++ b/docs/extending/public-releases.mdx
@@ -11,9 +11,9 @@ This document outlines how Flipper releases work on GitHub.
A release is kicked off by a special commit that has a subject with the format
`Flipper Release vX.Y.Z`, e.g. [4fa2c9761](https://github.com/facebook/flipper/commit/4fa2c9761a8359c65ccc62fee76490572616f0c1).
-This is triggered from a bot within Facebook that runs [prepare-release.sh](https://github.com/facebook/flipper/blob/master/scripts/prepare-release.sh)
+This is triggered from a bot within Facebook that runs [prepare-release.sh](https://github.com/facebook/flipper/blob/main/scripts/prepare-release.sh)
but the only thing special about the commit is its subject line. Anyone could run the
-script and would kick off the remaining jobs once the commit lands in master.
+script and would kick off the remaining jobs once the commit lands in main.
The commit bumps the version of Flipper Desktop as well as various SDK components
and libraries that are to be published to npm and other package repositories.
@@ -27,7 +27,7 @@ releases from the main branch.
## Desktop Release
The release process for the desktop app is entirely driven by [GitHub Actions](https://github.com/features/actions).
-The entry point is the [release.yml](https://github.com/facebook/flipper/blob/master/.github/workflows/release.yml) workflow
+The entry point is the [release.yml](https://github.com/facebook/flipper/blob/main/.github/workflows/release.yml) workflow
which is triggered by changes to the `desktop/package.json` file on the main branch.
GitHub Actions has a limitation we need to work around here: It allows push events to as triggers for
@@ -55,7 +55,7 @@ iOS releases are run in GitHub Actions but exist as a separate workflow. They ca
-[The workflow](https://github.com/facebook/flipper/blob/master/.github/workflows/publish-pods.yml) follows the default Cocoapods update procedure, bumps and published both the Flipper and FlipperKit pod
+[The workflow](https://github.com/facebook/flipper/blob/main/.github/workflows/publish-pods.yml) follows the default Cocoapods update procedure, bumps and published both the Flipper and FlipperKit pod
and finally creates a [pull request](https://github.com/facebook/flipper/pull/1754) containing the updated references. This PR must be manually merged.
**Authentication** is managed through the secret environment variable `COCOAPODS_TRUNK_TOKEN`.
@@ -64,9 +64,9 @@ and finally creates a [pull request](https://github.com/facebook/flipper/pull/17
The JavaScript libraries published as part of a Flipper release closely follow the iOS release procedure.
Same as before, it is a workflow that is triggered by one of the three events, which should in all but
-exceptional circumstances be a dispatch event. The workflow is defined in [publish-npm.yml](https://github.com/facebook/flipper/blob/master/.github/workflows/publish-npm.yml).
+exceptional circumstances be a dispatch event. The workflow is defined in [publish-npm.yml](https://github.com/facebook/flipper/blob/main/.github/workflows/publish-npm.yml).
-From there, we use a [script](https://github.com/facebook/flipper/blob/master/desktop/scripts/bump-versions.ts) to
+From there, we use a [script](https://github.com/facebook/flipper/blob/main/desktop/scripts/bump-versions.ts) to
bump the versions of our Yarn workspaces, and publish all public packages (`flipper`, `flipper-babel-transformer`, ...)
and our React Native bindings.
@@ -81,16 +81,16 @@ due to timeouts or network errors isn't a dealbreaker.
The three jobs are:
-1. The [`snapshot`](https://github.com/facebook/flipper/blob/master/.github/workflows/android-sample.yml) job runs on every commit on the main branch and publishes "SNAPSHOT" releases to Maven Central. It runs on CircleCI.
-2. The [`publish-android`](https://github.com/facebook/flipper/blob/master/.github/workflows/publish-android.yml) job is usually triggered by a `dispatch_workflow` event. It uploads our Java artifacts to Maven Central and attaches the Android sample app to the release page on GitHub. It runs on GitHub Actions.
-3. The [`android-sample`](https://github.com/facebook/flipper/blob/master/.github/workflows/android-sample.yml) job runs on every push and open pull request. It builds the sample and tutorial apps and uploads the sample APK as artifact for easy debugging and testing.
+1. The [`snapshot`](https://github.com/facebook/flipper/blob/main/.github/workflows/android-sample.yml) job runs on every commit on the main branch and publishes "SNAPSHOT" releases to Maven Central. It runs on CircleCI.
+2. The [`publish-android`](https://github.com/facebook/flipper/blob/main/.github/workflows/publish-android.yml) job is usually triggered by a `dispatch_workflow` event. It uploads our Java artifacts to Maven Central and attaches the Android sample app to the release page on GitHub. It runs on GitHub Actions.
+3. The [`android-sample`](https://github.com/facebook/flipper/blob/main/.github/workflows/android-sample.yml) job runs on every push and open pull request. It builds the sample and tutorial apps and uploads the sample APK as artifact for easy debugging and testing.
### CircleCI Configuration
The Android snapshot build is run on
-[CircleCI](https://app.circleci.com/pipelines/github/facebook/flipper?branch=master)
+[CircleCI](https://app.circleci.com/pipelines/github/facebook/flipper?branch=main)
and configured in
-[`.circleci/config.yml`](https://github.com/facebook/flipper/blob/master/.circleci/config.yml)
+[`.circleci/config.yml`](https://github.com/facebook/flipper/blob/main/.circleci/config.yml)
There are two potential points for breakage:
diff --git a/docs/extending/testing-rn.mdx b/docs/extending/testing-rn.mdx
index 638496068..b0e57866f 100644
--- a/docs/extending/testing-rn.mdx
+++ b/docs/extending/testing-rn.mdx
@@ -7,7 +7,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
When making changes to the React Native integration, it can be helpful to
test them directly in the [sample
-app](https://github.com/facebook/flipper/tree/master/react-native/ReactNativeFlipperExample)
+app](https://github.com/facebook/flipper/tree/main/react-native/ReactNativeFlipperExample)
we provide in the repository. However, the app is building against a production release
of Flipper and not the version checked in in the repository.
diff --git a/docs/features/react-native.mdx b/docs/features/react-native.mdx
index 524f891e8..85a6b2f9f 100644
--- a/docs/features/react-native.mdx
+++ b/docs/features/react-native.mdx
@@ -60,4 +60,4 @@ The React Native community has also started to build plugins for Flipper.
* [Reactotron's](https://infinite.red/reactotron) [Flipper plugin](https://github.com/infinitered/flipper-plugin-reactotron) is an example of a standalone React Native desktop app, [ported to work as a Flipper plugin](https://shift.infinite.red/better-react-native-debugging-with-reactotron-in-flipper-6b823af29220).
-*Got your own Flipper plugin for React Native you want to plug here? Please sent us a [Pull Request](https://github.com/facebook/flipper/blob/master/docs/features/react-native.mdx)!*
+*Got your own Flipper plugin for React Native you want to plug here? Please sent us a [Pull Request](https://github.com/facebook/flipper/blob/main/docs/features/react-native.mdx)!*
diff --git a/docs/getting-started/android-native.mdx b/docs/getting-started/android-native.mdx
index 79a876e01..f64f2dd6c 100644
--- a/docs/getting-started/android-native.mdx
+++ b/docs/getting-started/android-native.mdx
@@ -40,7 +40,7 @@ APIs provided by the `flipper` package and does not provide any plugin stubs.
It is recommended that you keep all Flipper instantiation code in a separate
build variant to ensure it doesn't accidentally make it into your production
builds. Check out [the sample
-app](https://github.com/facebook/flipper/tree/master/android/sample/src) to
+app](https://github.com/facebook/flipper/tree/main/android/sample/src) to
see how to organise your Flipper initialization into debug and release
variants.
@@ -90,7 +90,7 @@ It's recommended that you add the following activity to the manifest, which can
## Android Snapshots
-Feeling adventurous? We publish Android snapshot releases directly off of `master`.
+Feeling adventurous? We publish Android snapshot releases directly off of `main`.
You can get the latest version by adding the Maven Snapshot repository to your sources
and pointing to the most recent `-SNAPSHOT` version.
diff --git a/docs/troubleshooting.mdx b/docs/troubleshooting.mdx
index 6c7dc1902..0da77d576 100644
--- a/docs/troubleshooting.mdx
+++ b/docs/troubleshooting.mdx
@@ -72,7 +72,7 @@ adb shell am start -n