https://github.com/ionic-team/appflow-build
GitHub Action for triggering Appflow Builds
https://github.com/ionic-team/appflow-build
Last synced: 4 months ago
JSON representation
GitHub Action for triggering Appflow Builds
- Host: GitHub
- URL: https://github.com/ionic-team/appflow-build
- Owner: ionic-team
- License: mit
- Created: 2020-10-06T13:54:18.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-13T14:10:00.000Z (over 1 year ago)
- Last Synced: 2025-10-01T22:34:11.575Z (4 months ago)
- Language: TypeScript
- Size: 2.02 MB
- Stars: 52
- Watchers: 9
- Forks: 15
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Appflow Build Action for GitHub Actions
[](https://opensource.org/licenses/MIT)
Trigger [Appflow](https://useappflow.com) Capacitor & Cordova Mobile Builds.
## Usage
### Live Update
```yaml
- name: Build Live Update on Appflow
uses: ionic-team/appflow-build@v1
with:
token: ${{ secrets.APPFLOW_TOKEN }}
app-id: abcdef12
platform: Web
environment: MyEnvironment
```
> iOS & Android Builds Require a paid subscription to [Appflow](https://useappflow.com)
### iOS
```yaml
- name: Build iOS on Appflow
uses: ionic-team/appflow-build@v1
with:
token: ${{ secrets.APPFLOW_TOKEN }}
app-id: abcdef12
platform: iOS
build-type: ad-hoc
certificate: MyCertificate
environment: MyEnvironment
upload-artifact: iOS-Build.zip
```
### Android
```yaml
- name: Build Android on Appflow
uses: ionic-team/appflow-build@v1
with:
token: ${{ secrets.APPFLOW_TOKEN }}
app-id: abcdef12
platform: Android
build-type: debug
environment: MyEnvironment
upload-artifact: Android-Build.zip
```
> For the action to work you will need to [connect your Appflow app to GitHub](https://ionicframework.com/docs/appflow/quickstart/github) in the Appflow dashboard.
The action can build iOS & Android binaries for Capacitor & Cordova apps using Appflow from any type of runner.
You can easily use the [Appflow Dashboard](https://dashboard.ionicframework.com) to setup your application and use this
action to run you builds & upload them as artifacts to GitHub.
See [action.yml](action.yml) for the full documentation for this action's inputs and outputs.
> You can learn more about how to configure your build in the [Appflow docs](https://ionicframework.com/docs/appflow)
## Authentication
You will need a token to authenticate with Appflow.
The easiest way to get your token is to use the Ionic CLI to login & retrieve the token.
To login type:
```bash
npm i -g @ionic/cli
ionic login
```
Then you can use the following command to see your token:
```bash
ionic config get -g tokens.user
```
Prevent the CLI from invalidating the token:
```bash
ionic config unset -g tokens.refresh
ionic config unset -g tokens.user
```
## License
[MIT](/LICENSE)