jens/flipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename default branch references to main (#2689)

Browse Source 
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
2021-08-13 14:57:29 -07:00
committed by Facebook GitHub Bot
parent 1a4c26a42b
commit 781df776f2
34 changed files with 53 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/extending/public-releases.mdx
View File

@@ -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: