https://github.com/appflowy-io/appflowy-builder
https://github.com/appflowy-io/appflowy-builder
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/appflowy-io/appflowy-builder
- Owner: AppFlowy-IO
- Created: 2023-08-02T05:34:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2026-06-12T08:49:50.000Z (26 days ago)
- Last Synced: 2026-06-12T10:22:36.986Z (26 days ago)
- Size: 371 KB
- Stars: 12
- Watchers: 4
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://docs.github.com/en/actions/security-guides/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](https://docs.github.com/en/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development).
### 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](https://docs.flutter.dev/deployment/android#sign-the-app).
### 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](https://docs.github.com/en/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development) 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](https://scriptingosx.com/2021/07/notarize-a-command-line-tool-with-notarytool).
Example command for macOS notarization:
```sh
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.