Rename default branch references to main (#2689)
Summary: I really hope I hit everything and didn't break anything that wasn't referring to branch names. Pull Request resolved: https://github.com/facebook/flipper/pull/2689 Test Plan: _eyes CI |[Site Preview: flipper](https://our.intern.facebook.com/intern/staticdocs/eph/D30305789/V2/flipper/) Reviewed By: timur-valiev Differential Revision: D30305789 Pulled By: passy fbshipit-source-id: 5daaa09250bb96bb50be679fc01dae86c666eb73
This commit is contained in:
Pascal Hartig
committed by
Facebook GitHub Bot
Facebook GitHub Bot
parent
1a4c26a42b
commit
781df776f2
@@ -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
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
@@ -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).
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
<img alt="Manually triggering a workflow" src={useBaseUrl("img/trigger-publish-pod-workflow.png")} />
|
||||
|
||||
[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:
|
||||
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user