Skip to content
This repository was archived by the owner on Nov 22, 2024. It is now read-only.

Commit 781df77

Browse files
passyfacebook-github-bot
authored andcommitted
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: #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
1 parent 1a4c26a commit 781df77

34 files changed

+53
-53
lines changed

.circleci/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,4 @@ workflows:
3030
- snapshot:
3131
filters:
3232
branches:
33-
only: master
33+
only: main

.github/workflows/docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Docs
22
on:
33
push:
44
branches:
5-
- master
5+
- main
66

77
jobs:
88
build-and-deploy:

.github/workflows/publish-pods.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ jobs:
131131
- Make sure that the Podfile.lock contains latest FlipperKit and Flipper pod versions.
132132
- Also make sure that all the dependencies are updated to the latest one.
133133
- This is auto-generated by [create-pull-request](https://github.com/peter-evans/create-pull-request)
134-
base: "master"
134+
base: "main"
135135
branch-suffix: short-commit-hash
136136
labels: automated pr
137137
env:

.github/workflows/release.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: Release
22
on:
33
push:
44
branches:
5-
- master
5+
- main
66
paths:
77
- 'desktop/package.json'
88

@@ -38,7 +38,7 @@ jobs:
3838
tag_name: ${{ steps.tag-version-commit.outputs.tag }}
3939
release_name: ${{ steps.tag-version-commit.outputs.tag }}
4040
body: |
41-
See https://github.com/facebook/flipper/blob/master/desktop/static/CHANGELOG.md
41+
See https://github.com/facebook/flipper/blob/main/desktop/static/CHANGELOG.md
4242
for full notes.
4343
draft: false
4444
prerelease: false

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ when dealing with platform-specific code.
2020

2121
We actively welcome your pull requests.
2222

23-
1. Fork the repo and create your branch from `master`.
23+
1. Fork the repo and create your branch from `main`.
2424
2. If you've added code that should be tested, add tests.
2525
3. If you've changed APIs, update the documentation.
2626
4. Ensure the test suite passes.

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
</h1>
77
<p align="center">
88
<a href="https://travis-ci.org/facebook/flipper">
9-
<img src="https://travis-ci.org/facebook/flipper.svg?branch=master" alt="Build Status" />
9+
<img src="https://travis-ci.org/facebook/flipper.svg?branch=main" alt="Build Status" />
1010
</a>
1111
<a href="https://search.maven.org/artifact/com.facebook.flipper/flipper">
1212
<img src="https://img.shields.io/maven-central/v/com.facebook.flipper/flipper" alt="Android Maven Badge" />

desktop/flipper-plugin/src/data-source/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ _Library to power streamig data visualisations as used in Facebook's Flipper_
1212
* [Demo sandbox](https://codesandbox.io/s/flipper-datasource-demo-iy0tq)
1313
* [Demo setup recording](https://www.youtube.com/watch?v=stL66GByQU0)
1414
* [In-depth introduction talk, featured at @fwdays, 5-6-2021](https://www.youtube.com/watch?v=WCs09c1B1Lk)
15-
* [Source code](https://github.com/facebook/flipper/tree/master/desktop/flipper-plugin/src/data-source)
15+
* [Source code](https://github.com/facebook/flipper/tree/main/desktop/flipper-plugin/src/data-source)
1616
* [Lightning talk using DataSource in Logs view](https://fb.workplace.com/groups/427492358561913/permalink/432720091372473/) [FB-Only]
1717
* [DataSource project plan](https://fb.quip.com/noJDArpLF7Fe) [FB-Only]
1818
* [Demo project](https://www.internalfb.com/code/flipper/src/fbsource/xplat/sonar/facebook/data-source-demo/) [FB-Only]

desktop/flipper-plugin/src/data-source/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": "0.0.2",
44
"description": "Library to power streamig data visualisations",
55
"repository": "https://github.com/facebook/flipper",
6-
"homepage": "https://github.com/facebook/flipper/blob/master/desktop/flipper-plugin/src/data-source/README.md",
6+
"homepage": "https://github.com/facebook/flipper/blob/main/desktop/flipper-plugin/src/data-source/README.md",
77
"author": "Facebook Inc",
88
"license": "MIT",
99
"source": "index.tsx",

desktop/pkg/schemas/plugin-package-v2.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
},
2727
"icon": {
2828
"type": "string",
29-
"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."
29+
"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."
3030
},
3131
"keywords": {
3232
"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.",

docs/extending/create-plugin.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -301,8 +301,8 @@ Here, `sendData` is an example of a method that might be implemented by the Flip
301301
302302
An minimal communication demo can be found in our [Sample project]:
303303
304-
* [Desktop implementation](https://github.com/facebook/flipper/blob/master/desktop/plugins/public/example/index.tsx)
305-
* [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)
304+
* [Desktop implementation](https://github.com/facebook/flipper/blob/main/desktop/plugins/public/example/index.tsx)
305+
* [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)
306306
307307
## Background Plugins
308308

docs/extending/desktop-plugin-structure.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Important attributes of `package.json`:
9191

9292
- `title` Shown in the main sidebar as the human-readable name of the plugin.
9393

94-
- `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.
94+
- `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.
9595

9696
- `bugs` Specify an email and/or url, where plugin bugs should be reported.
9797

docs/extending/establishing-a-connection.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -72,4 +72,4 @@ For Flipper desktop to work with a given Client type, it needs to be modified to
7272

7373
`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.
7474

75-
You can see the current implementations in [CertificateProvider.tsx](https://github.com/facebook/flipper/blob/master/desktop/app/src/utils/CertificateProvider.tsx).
75+
You can see the current implementations in [CertificateProvider.tsx](https://github.com/facebook/flipper/blob/main/desktop/app/src/utils/CertificateProvider.tsx).

docs/extending/flipper-plugin.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -976,11 +976,11 @@ See `View > Flipper Style Guide` inside the Flipper application for more details
976976
A set of globally available utilities like opening links, interacting with the clipboard, etc.
977977
Example: `getFlipperLib().writeTextToClipboard("hello from Flipper");
978978

979-
The full set of utilities can be found [here](https://github.com/facebook/flipper/blob/master/desktop/flipper-plugin/src/plugin/FlipperLib.tsx#L20)
979+
The full set of utilities can be found [here](https://github.com/facebook/flipper/blob/main/desktop/flipper-plugin/src/plugin/FlipperLib.tsx#L20)
980980

981981
### createTablePlugin
982982

983-
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.
983+
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.
984984

985985
`createTablePlugin` creates a plugin that handles receiving data from the client and
986986
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.

docs/extending/new-clients.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ In the GitHub repo, you'll find Flipper clients for Android, iOS and C++ code, b
77

88
Flipper clients communicate with the Flipper desktop app using JSON RPC messages over an [RSocket](http://rsocket.io/) connection.
99

10-
This page documents the API, and you can use [FlipperConnectionManagerImpl.cpp](https://github.com/facebook/flipper/blob/master/xplat/Flipper/FlipperConnectionManagerImpl.cpp) for reference.
10+
This page documents the API, and you can use [FlipperConnectionManagerImpl.cpp](https://github.com/facebook/flipper/blob/main/xplat/Flipper/FlipperConnectionManagerImpl.cpp) for reference.
1111

1212
## Establishing a connection
1313
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}
3737

3838
**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.
3939

40-
**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.
40+
**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.
4141

4242
## Responding to messages
4343

docs/extending/public-releases.mdx

+11-11
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ This document outlines how Flipper releases work on GitHub.
1111
A release is kicked off by a special commit that has a subject with the format
1212
`Flipper Release vX.Y.Z`, e.g. [4fa2c9761](https://github.com/facebook/flipper/commit/4fa2c9761a8359c65ccc62fee76490572616f0c1).
1313

14-
This is triggered from a bot within Facebook that runs [prepare-release.sh](https://github.com/facebook/flipper/blob/master/scripts/prepare-release.sh)
14+
This is triggered from a bot within Facebook that runs [prepare-release.sh](https://github.com/facebook/flipper/blob/main/scripts/prepare-release.sh)
1515
but the only thing special about the commit is its subject line. Anyone could run the
16-
script and would kick off the remaining jobs once the commit lands in master.
16+
script and would kick off the remaining jobs once the commit lands in main.
1717

1818
The commit bumps the version of Flipper Desktop as well as various SDK components
1919
and libraries that are to be published to npm and other package repositories.
@@ -27,7 +27,7 @@ releases from the main branch.
2727
## Desktop Release
2828

2929
The release process for the desktop app is entirely driven by [GitHub Actions](https://github.com/features/actions).
30-
The entry point is the [release.yml](https://github.com/facebook/flipper/blob/master/.github/workflows/release.yml) workflow
30+
The entry point is the [release.yml](https://github.com/facebook/flipper/blob/main/.github/workflows/release.yml) workflow
3131
which is triggered by changes to the `desktop/package.json` file on the main branch.
3232

3333
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
5555

5656
<img alt="Manually triggering a workflow" src={useBaseUrl("img/trigger-publish-pod-workflow.png")} />
5757

58-
[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
58+
[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
5959
and finally creates a [pull request](https://github.com/facebook/flipper/pull/1754) containing the updated references. This PR must be manually merged.
6060

6161
**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
6464

6565
The JavaScript libraries published as part of a Flipper release closely follow the iOS release procedure.
6666
Same as before, it is a workflow that is triggered by one of the three events, which should in all but
67-
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).
67+
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).
6868

69-
From there, we use a [script](https://github.com/facebook/flipper/blob/master/desktop/scripts/bump-versions.ts) to
69+
From there, we use a [script](https://github.com/facebook/flipper/blob/main/desktop/scripts/bump-versions.ts) to
7070
bump the versions of our Yarn workspaces, and publish all public packages (`flipper`, `flipper-babel-transformer`, ...)
7171
and our React Native bindings.
7272

@@ -81,16 +81,16 @@ due to timeouts or network errors isn't a dealbreaker.
8181

8282
The three jobs are:
8383

84-
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.
85-
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.
86-
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.
84+
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.
85+
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.
86+
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.
8787

8888
### CircleCI Configuration
8989

9090
The Android snapshot build is run on
91-
[CircleCI](https://app.circleci.com/pipelines/github/facebook/flipper?branch=master)
91+
[CircleCI](https://app.circleci.com/pipelines/github/facebook/flipper?branch=main)
9292
and configured in
93-
[`.circleci/config.yml`](https://github.com/facebook/flipper/blob/master/.circleci/config.yml)
93+
[`.circleci/config.yml`](https://github.com/facebook/flipper/blob/main/.circleci/config.yml)
9494

9595
There are two potential points for breakage:
9696

docs/extending/testing-rn.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
77

88
When making changes to the React Native integration, it can be helpful to
99
test them directly in the [sample
10-
app](https://github.com/facebook/flipper/tree/master/react-native/ReactNativeFlipperExample)
10+
app](https://github.com/facebook/flipper/tree/main/react-native/ReactNativeFlipperExample)
1111
we provide in the repository. However, the app is building against a production release
1212
of Flipper and not the version checked in in the repository.
1313

docs/features/react-native.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,4 +60,4 @@ The React Native community has also started to build plugins for Flipper.
6060

6161
* [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).
6262

63-
*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)!*
63+
*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)!*

docs/getting-started/android-native.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ APIs provided by the `flipper` package and does not provide any plugin stubs.
4040
It is recommended that you keep all Flipper instantiation code in a separate
4141
build variant to ensure it doesn't accidentally make it into your production
4242
builds. Check out [the sample
43-
app](https://github.com/facebook/flipper/tree/master/android/sample/src) to
43+
app](https://github.com/facebook/flipper/tree/main/android/sample/src) to
4444
see how to organise your Flipper initialization into debug and release
4545
variants.
4646

@@ -90,7 +90,7 @@ It's recommended that you add the following activity to the manifest, which can
9090

9191
## Android Snapshots
9292

93-
Feeling adventurous? We publish Android snapshot releases directly off of `master`.
93+
Feeling adventurous? We publish Android snapshot releases directly off of `main`.
9494

9595
You can get the latest version by adding the Maven Snapshot repository to your sources
9696
and pointing to the most recent `-SNAPSHOT` version.

0 commit comments

Comments
 (0)