AppFlowy Builder

AppFlowy Builder is a tool designed to streamline the process of building and deploying AppFlowy applications across multiple platforms. This document outlines the necessary steps and requirements to use this tool effectively.

Getting Started

Before you begin, ensure you have the required secrets set in your repository settings. These secrets are essential for the workflows to operate correctly. For guidance on creating secrets, see GitHub's documentation on using secrets in GitHub Actions.

Requirements for iOS

To build for iOS, set the following secrets in your repository:

• IOS_CERTIFICATE_BASE64
• IOS_KEYCHAIN_PASSWORD
• IOS_PROVISION_PROFILE_BASE64
• P12_PASSWORD

For instructions on creating these secrets, refer to GitHub's guide on deploying Xcode applications.

Requirements for Android

To build for Android, set the following secrets:

• ANDROID_UPLOAD_KEYSTORE
• ANDROID_UPLOAD_KEYSTORE_KEY_PASSWORD
• ANDROID_UPLOAD_KEYSTORE_STORE_PASSWORD

For instructions on creating these secrets, see Flutter's deployment guide for Android.

Requirements for macOS

To build for macOS, set the following secrets:

• MACOS_CERTIFICATE_BASE64
• MACOS_CODESIGN_ID

Refer to GitHub's guide on deploying Xcode applications for details.

Optional secrets for macOS:

• MACOS_NOTARY_PWD
• MACOS_NOTARY_USER
• MACOS_TEAM_ID

For instructions on creating these secrets, see this guide on notarizing a command-line tool with NotaryTool.

Example command for macOS notarization:

xcrun notarytool submit AppFlowy.dmg --apple-id [YOUR_APPLE_ID] --team-id [YOUR_TEAM_ID] --password [YOUR_APPLE_APP_SPECIFIC_PASSWORD] -v -f "json" --wait

How to use

Caution

Remember, all packages are zipped. Ensure to unzip them before use.

• Navigate to the Actions tab in your repository.
• Select the workflow you wish to run.
• Click the Run workflow button.
• Enter the required variables as prompted.

Release packages

Caution

The following steps are only for the AppFlowy team. If you are a contributor, please ignore this section.

• To begin the release process, clone the AppFlowy-Builder repository to your local machine using the following command:

git clone [email protected]:AppFlowy-IO/AppFlowy-Builder.git

After cloning the repository, you can initiate the build process by creating a new tag and pushing it to the repository. Here's how to do it:

git tag -a 0.0.1_main && git push origin 0.0.1_main

This action triggers the build process, which utilizes the main branch to compile the AppFlowy desktop application. The build will include the latest commit from the specified branch.

You can monitor the progress and status of the build process here.

• Stage (Staging): This is a pre-production environment used for testing. After development, the code is deployed to this environment to simulate how it would work in the production environment.
• Prod (Production): This is the live environment where the application runs for the end-users.