From 57584a38fab99199a48748bda7303d71beb98d75 Mon Sep 17 00:00:00 2001
From: Lorenzo Blasa
Date: Tue, 28 Nov 2023 09:03:54 -0800
Subject: [PATCH] Electron distribution announcement
Summary:
Update our README file with an announcement of our distribution change. I will pair the announcement with an update to our GitHub workflow as to not produce any more Electron builds for future releases.
Changelog: Flipper Electron distribution change announcement.
Reviewed By: aigoncharov
Differential Revision: D51616454
fbshipit-source-id: 5ff513b3d99c8100ed8241d1bdafebf1d6dcfa10
---
.github/workflows/release.yml | 121 +---------------------------------
README.md | 18 +++++
2 files changed, 19 insertions(+), 120 deletions(-)
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 3a1ff8029..1a4df5d9a 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -45,38 +45,6 @@ jobs:
draft: false
prerelease: false
- build-mac:
- needs:
- - release
- runs-on: macos-latest
- env:
- desktop-directory: ./desktop
-
- steps:
- - uses: actions/checkout@v3.5.3
- with:
- ref: ${{ needs.release.outputs.tag }}
- - uses: actions/setup-node@v3.6.0
- with:
- node-version: '18.x'
- - name: Install
- uses: nick-fields/retry@v2.8.3
- with:
- timeout_minutes: 10
- max_attempts: 3
- command: cd ${{env.desktop-directory}} && yarn
- - name: Build
- uses: nick-fields/retry@v2.8.3
- with:
- timeout_minutes: 30
- max_attempts: 3
- command: cd ${{env.desktop-directory}} && yarn build --mac --mac-dmg
- - name: Upload
- uses: actions/upload-artifact@v3.1.2
- with:
- name: 'Flipper-mac.dmg'
- path: 'dist/Flipper-mac.dmg'
-
build-server-mac:
needs:
- release
@@ -112,72 +80,6 @@ jobs:
name: 'Flipper-server-mac-aarch64.dmg'
path: 'dist/Flipper-server-mac-aarch64.dmg'
- build-linux:
- needs:
- - release
- runs-on: ubuntu-latest
- env:
- desktop-directory: ./desktop
-
- steps:
- - uses: actions/checkout@v3.5.3
- with:
- ref: ${{ needs.release.outputs.tag }}
- - uses: actions/setup-node@v3.6.0
- with:
- node-version: '18.x'
- - name: Install
- uses: nick-fields/retry@v2.8.3
- with:
- timeout_minutes: 10
- max_attempts: 3
- command: cd ${{env.desktop-directory}} && yarn
- - name: Build
- uses: nick-fields/retry@v2.8.3
- with:
- timeout_minutes: 30
- max_attempts: 3
- command: cd ${{env.desktop-directory}} && yarn build --linux
- - name: Upload Linux
- uses: actions/upload-artifact@v3.1.2
- with:
- name: 'Flipper-linux.zip'
- path: 'dist/Flipper-linux.zip'
-
- build-win:
- needs:
- - release
- runs-on: windows-latest
- env:
- desktop-directory: ./desktop
-
- steps:
- - uses: actions/checkout@v3.5.3
- with:
- ref: ${{ needs.release.outputs.tag }}
- - uses: actions/setup-node@v3.6.0
- with:
- node-version: '18.x'
- - name: Install
- uses: nick-fields/retry@v2.8.3
- with:
- timeout_minutes: 10
- max_attempts: 3
- shell: pwsh
- command: cd ${{env.desktop-directory}}; yarn
- - name: Build
- uses: nick-fields/retry@v2.8.3
- with:
- timeout_minutes: 30
- max_attempts: 3
- shell: pwsh
- command: cd ${{env.desktop-directory}}; yarn build --win
- - name: Upload Windows
- uses: actions/upload-artifact@v3.1.2
- with:
- name: 'Flipper-win.zip'
- path: 'dist/Flipper-win.zip'
-
build-flipper-server:
needs:
- release
@@ -210,9 +112,6 @@ jobs:
publish:
needs:
- - build-win
- - build-linux
- - build-mac
- build-server-mac
- build-flipper-server
- release
@@ -222,12 +121,6 @@ jobs:
- uses: actions/checkout@v3.5.3
with:
ref: ${{ needs.release.outputs.tag }}
- - name: Download Mac
- if: ${{ needs.release.outputs.tag != '' }}
- uses: actions/download-artifact@v1
- with:
- name: 'Flipper-mac.dmg'
- path: 'Flipper-mac.dmg'
- name: Download Flipper Server x86-64
if: ${{ needs.release.outputs.tag != '' }}
uses: actions/download-artifact@v1
@@ -240,18 +133,6 @@ jobs:
with:
name: 'Flipper-server-mac-aarch64.dmg'
path: 'Flipper-server-mac-aarch64.dmg'
- - name: Download Linux
- if: ${{ needs.release.outputs.tag != '' }}
- uses: actions/download-artifact@v1
- with:
- name: 'Flipper-linux.zip'
- path: 'Flipper-linux.zip'
- - name: Download Windows
- if: ${{ needs.release.outputs.tag != '' }}
- uses: actions/download-artifact@v1
- with:
- name: 'Flipper-win.zip'
- path: 'Flipper-win.zip'
- name: Download Flipper Server
if: ${{ needs.release.outputs.tag != '' }}
uses: actions/download-artifact@v1
@@ -265,7 +146,7 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
created_tag: ${{ needs.release.outputs.tag }}
- args: Flipper-mac.dmg/Flipper-mac.dmg Flipper-linux.zip/Flipper-linux.zip Flipper-win.zip/Flipper-win.zip flipper-server.tgz/flipper-server.tgz Flipper-server-mac-x64.dmg/Flipper-server-mac-x64.dmg Flipper-server-mac-aarch64.dmg/Flipper-server-mac-aarch64.dmg
+ args: flipper-server.tgz/flipper-server.tgz Flipper-server-mac-x64.dmg/Flipper-server-mac-x64.dmg Flipper-server-mac-aarch64.dmg/Flipper-server-mac-aarch64.dmg
- name: Set up npm token
run: echo "//registry.yarnpkg.com/:_authToken=${{ secrets.FLIPPER_NPM_TOKEN }}" >> ~/.npmrc
- name: Publish flipper-server on NPM
diff --git a/README.md b/README.md
index 727eed423..e6eb68ffd 100644
--- a/README.md
+++ b/README.md
@@ -13,6 +13,24 @@
+---
+## Important Accouncement
+
+Flipper is moving away from its Electron distribution to an in-Browser experience.
+
+**How does this affect me?**
+
+Functionality hasn't changed. The UI remains unchanged. Flipper will run in your default browser instead of a standalone application.
+If you build from source, Flipper will open in the browser instead of a standalone app. We also provide a MacOS app for the Flipper runtime which can be run and will also open Flipper in the browser.
+
+The last Electron release is [v0.239.0](https://github.com/facebook/flipper/releases/tag/v0.239.0). As such, future releases will not include Electron artifacts.
+
+### React Native support
+
+If you are debugging React Native applications, v0.239.0 will be the last release with support for it due to technical limitations for React Dev Tools and Hermes Debugger plugins. As such, please refer to that release when debugging React Native applications.
+
+---
+
Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android and JS apps in your browser or in Node.js. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.