From 6c1eb4468696e3a1c7f67bc2191250f36dd6fa85 Mon Sep 17 00:00:00 2001 From: Jigar-f Date: Fri, 14 Jun 2024 12:10:38 +0530 Subject: [PATCH] Updated readme and updated more actions pacakges. --- .github/workflows/browerstack.yml | 2 +- .github/workflows/build-android.yml | 2 +- .github/workflows/build-darwin.yml | 2 +- .github/workflows/build-ios.yml | 2 +- .github/workflows/build-linux.yml | 2 +- .github/workflows/build-windows.yml | 2 +- .github/workflows/go.yml | 2 +- .github/workflows/release.yml | 6 +++--- README.md | 29 +++++++++++++++++++++++++---- 9 files changed, 35 insertions(+), 14 deletions(-) diff --git a/.github/workflows/browerstack.yml b/.github/workflows/browerstack.yml index 256948b29..bc9be0185 100644 --- a/.github/workflows/browerstack.yml +++ b/.github/workflows/browerstack.yml @@ -27,7 +27,7 @@ jobs: - run: flutter --version - name: Setup Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: go-version-file: "go.mod" diff --git a/.github/workflows/build-android.yml b/.github/workflows/build-android.yml index b2d741a9e..a0c761f87 100644 --- a/.github/workflows/build-android.yml +++ b/.github/workflows/build-android.yml @@ -40,7 +40,7 @@ jobs: flutter-version-file: pubspec.yaml - name: Setup Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: go-version-file: "go.mod" diff --git a/.github/workflows/build-darwin.yml b/.github/workflows/build-darwin.yml index 1df09d269..9b11b96a0 100644 --- a/.github/workflows/build-darwin.yml +++ b/.github/workflows/build-darwin.yml @@ -42,7 +42,7 @@ jobs: run: git lfs pull - name: Setup Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: go-version-file: "go.mod" diff --git a/.github/workflows/build-ios.yml b/.github/workflows/build-ios.yml index 18191a93c..e4a636bcc 100644 --- a/.github/workflows/build-ios.yml +++ b/.github/workflows/build-ios.yml @@ -41,7 +41,7 @@ jobs: run: git lfs pull - name: Setup Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: go-version-file: "go.mod" diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml index 91c41a248..7560145c7 100644 --- a/.github/workflows/build-linux.yml +++ b/.github/workflows/build-linux.yml @@ -39,7 +39,7 @@ jobs: sudo apt-get install -y libgtk-3-0 libblkid1 liblzma5 sudo apt-get install -y libpcap-dev libgtk-3-dev libayatana-appindicator3-dev ruby ruby-dev && sudo gem install bundler -v 2.2.26 - - uses: actions/setup-go@v4 + - uses: actions/setup-go@v5 with: go-version-file: "go.mod" diff --git a/.github/workflows/build-windows.yml b/.github/workflows/build-windows.yml index 68c8da872..c2fa91e55 100644 --- a/.github/workflows/build-windows.yml +++ b/.github/workflows/build-windows.yml @@ -46,7 +46,7 @@ jobs: run: git lfs pull - name: Setup Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: go-version-file: "go.mod" diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml index 2ce1f00d7..c25832e77 100644 --- a/.github/workflows/go.yml +++ b/.github/workflows/go.yml @@ -17,7 +17,7 @@ jobs: - name: Install libpcap run: sudo apt-get install libpcap-dev - name: Set up Go - uses: actions/setup-go@v4 + uses: actions/setup-go@v5 with: go-version-file: "go.mod" - name: Granting private modules access diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 53c500f1b..19a9745c4 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -172,17 +172,17 @@ jobs: name: windows64-installer-signed - name: Download the apk build output - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: android-apk-build - name: Download the aab build output - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: android-aab-build - name: Download the IPA - uses: actions/download-artifact@v3 + uses: actions/download-artifact@v4 with: name: Lantern.ipa diff --git a/README.md b/README.md index ca9c23726..8e24e90a1 100644 --- a/README.md +++ b/README.md @@ -227,9 +227,13 @@ Do this to make a release build: - Run `VERSION= make android-release ANDROID_ARCH=all` - Or, `DEVELOPMENT_MODE=true make android-release ANDROID_ARCH=all` to enable "Development Mode" which has extra dev features like taking screenshots and dev settings. -### Building release packages +### 📦 Building Release Packages and Distributing the App -Lantern Android release packages are built in CI. You can build installers for beta, for production, or for internal testing by varying the tag syntax. To build for production, you simply tag the current version on `main` with, for example: +Lantern-client release and beta packages are built using Continuous Integration (CI). You can create installers for beta, production, or internal testing by adjusting the tag syntax. + +#### Production Release for All Platforms 🌍 + +To release the production version for all platforms (including Android, iOS, and macOS), use the following command: `git tag -a "lantern-7.0.0" -f -m "Tagging production release"` @@ -241,9 +245,26 @@ Finally, to create an internal build, use "internal", as in: `git tag -a "lantern-7.0.0-internal" -f -m "Tagging internal release"` -For all of the above, don't forget to push the tags: -`git push --tags -f` +#### Platform-Specific Releases 📱💻 + +For releasing to specific platforms, use the appropriate prefix: + +* iOS: ios- +* Android: android- +* Desktop (Windows, macOS, Linux): desktop- + +Example command for releasing a beta version for Android: + +`git tag -a "android-lantern-7.0.0" -f -m "Tagging production release"` + +This command will build and release the beta version for Android. + +#### Pushing Tags to GitHub 🛠️ + +After creating a tag, push it to GitHub to trigger the CI/CD pipeline: + +`git push origin [TAG-NAME]`or `git push origin lantern-7.0.0` You can then find all built binaries in the [lantern-binaries repository](https://github.com/getlantern/lantern-binaries).