Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fivethree-team/ionic-fastlane-plugin
🧩 fastlane plugin for Ionic 4+
https://github.com/fivethree-team/ionic-fastlane-plugin
cd ci fastlane fastlane-cordova fastlane-ionic fastlane-plugin ionic
Last synced: 3 months ago
JSON representation
🧩 fastlane plugin for Ionic 4+
- Host: GitHub
- URL: https://github.com/fivethree-team/ionic-fastlane-plugin
- Owner: fivethree-team
- License: mit
- Created: 2018-08-26T14:45:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-05-20T10:41:25.000Z (over 4 years ago)
- Last Synced: 2024-09-28T10:41:31.485Z (3 months ago)
- Topics: cd, ci, fastlane, fastlane-cordova, fastlane-ionic, fastlane-plugin, ionic
- Language: Ruby
- Homepage: https://rubygems.org/gems/fastlane-plugin-fivethree_ionic
- Size: 3.04 MB
- Stars: 14
- Watchers: 3
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ionic-fastlane-plugin
[fastlane plugin](https://rubygems.org/gems/fastlane-plugin-fivethree_ionic) for Ionic 4+.
## Table of content
- [Getting started](#getting-started)
- [Actions](#actions)
## Getting started
Install the ionic-fastlane plugin
```console
fastlane add_plugin fastlane-plugin-fivethree_ionic
```
This will add `gem 'fastlane-plugin-fivethree_ionic'` in the `fastlane/Pluginfile`.
## Actions
This [Fastfile](./fastlane-plugin-fivethree_ionic/fastlane/Fastfile) contains example of the following actions.
| Action | Description |
| ------------------------------------------------------------------- | ------------------------------------------------------------- |
| [fiv_add_transparent_statusbar](#fiv_add_transparent_statusbar) |
| [fiv_build_ionic_android](#fiv_build_ionic_android) |
| [fiv_android_keystore](#fiv_android_keystore) | Generate an Android keystore file or validate keystore exists |
| [fiv_build_ionic_android](#fiv_build_ionic_android) |
| [fiv_bump_version](#fiv_bump_version) |
| [fiv_clean_install](#fiv_clean_install) |
| [fiv_increment_build_no](#fiv_increment_build_no) |
| [fiv_ionic](#fiv_ionic) | Build your Ionic app for a specific platform |
| [fiv_select_client](#fiv_select_client) | Select a client for white labeling the app |
| [fiv_select_clients](#fiv_select_clients) | Select all, many or one client for white labeling the app |
| [fiv_select_env](#fiv_select_env) | Select an environment folder for white labeling the app |
| [fiv_sign_android](#fiv_sign_android) | Zipalign, sign and verify apk |
| [fiv_update_version](#fiv_update_version) |
| [fiv_update_version_and_build_no](#fiv_update_version_and_build_no) |
| [fiv_version](#fiv_version) |
### fiv_add_transparent_statusbar
### fiv_android_keystore
Generate an Android keystore file or validate keystore exists
#### Options
| Options | Description | Type | Default | Required |
| ------------- | ------------------------- | -------- | -------------------- | -------- |
| keystore_path | Path to the android | `string` | `./fastlane/android` | `false` |
| keystore_name | Name of the keystore | `string` | | `true` |
| key_alias | Key alias of the keystore | `string` | | `true` |
### fiv_build_ionic_android
### fiv_bump_version
### fiv_clean_install
### fiv_increment_build_no
### fiv_ionic
Build your Ionic app for iOS:
```ruby
outputpath =
fiv_ionic(
platform: 'ios', release: 'true', prod: 'true', team_id: 'YOUR_TEAM_ID'
)
```
Build your Ionic app for Android:
```ruby
outputpath = fiv_ionic(platform: 'android', release: 'true', prod: 'true')
```
#### Options
| Options | Description | Type | Default |
| -------- | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | ---------- |
| platform | Platform to build on. Can be android, ios or browser | `android` \| `browser` \| `ios` |
| prod | Build for production | `true` \| `false` | `false` |
| release | Build for release if `true`, or for debug if `false` | `true` \| `false` | `true` |
| team_id | The development team (Team ID) to use for code signing | `string` |
| type | This will determine what type of build is generated by Xcode. Valid options are `development`, `enterprise`, `adhoc`, and `appstore` | `development` \| `enterprise` \| `adhoc` \| `appstore` | `appstore` |
### fiv_select_client
Add `fiv_select_client` to your lane to select a client for copying client specific resources before your app build.
For example you have the following app clients:
- clients
- companyA
- resources
- ...
- companyB
- companyZ
`fiv_select_client()` lets you select one client and returns the client name.
```ruby
client = fiv_select_client
# copy client resources e.g. "cp ../clients/#{client}/resources ../"
# build app
```
#### CI
Client selection can also be passed as an option for a non interactive environment. Add the option `client` to `before_all` and assign it to an environment variable `CLIENT`.
```ruby
before_all { |lane, options| ENV['CLIENT'] = options[:client] }
```
`fastlane example_lane client:companyA`
#### Options
| Options | Description | Type | Default | Required |
| -------------- | ------------------------------------------ | -------- | --------- | -------- |
| clients_folder | Path to your clients white label resources | `string` | `clients` | `false` |
### fiv_select_clients
Add `fiv_select_clients` to your lane to select all, many or one client for copying client specific resources before your app build in a loop.
For example you have the following app clients:
- clients
- companyA
- resources
- ...
- companyB
- companyZ
`fiv_select_clients()` lets you select all, many or one client and returns an array of client names.
```ruby
clients = fiv_select_clients
clients.each { |client| }
```
#### CI
Clients selection can also be passed as an option for a non interactive environment. Add the option `clients` to `before_all` and assign it to an environment variable `CLIENTS`.
```ruby
before_all { |lane, options| ENV['CLIENTS'] = options[:clients] }
```
Seperate clients by `,`:
`fastlane example_lane clients:companyA,companyB`
#### Options
| Options | Description | Type | Default | Required |
| -------------- | ------------------------------------------ | -------- | --------- | -------- |
| clients_folder | Path to your clients white label resources | `string` | `clients` | `false` |
### fiv_select_env
Add `fiv_select_env` to your lane to select an environment of a client for copying specific resources for this environment before your app build. e.g the resources or app icon and splash screen might differ for each environment.
For example you have the following app clients with different environments:
- clients
- companyA
- resources
- environment
- prod
- resources
- qa
- resources
- test
- resorces
- companyB
- companyZ
`fiv_select_env()` lets you select one client and returns the client name.
```ruby
client = fiv_select_client
env = fiv_select_env(client: client)
# copy client resources from environment e.g. "cp ../clients/#{client}/enviroment/#{env}/resources ../"
# build app
```
#### CI
Environment selection can also be passed as an option for a non interactive environment. Add the option `env` to `before_all` and assign it to an environment variable `ENV`.
```ruby
before_all do |lane, options|
ENV['CLIENT'] = options[:client]
ENV['ENV'] = options[:env]
end
```
`fastlane example_lane client:companyA env:prod`
#### Options
| Options | Description | Type | Default | Required |
| ------------------- | ----------------------------------------------- | -------- | -------------- | -------- |
| clients_folder | Path to your clients white label resources | `string` | `clients` | `false` |
| environments_folder | Path to your environments white label resources | `string` | `environments` | `false` |
| client | Path to your selected client | `string` | | `true` |
### fiv_sign_android
Zipaligns, [signs v2](https://source.android.com/security/apksigning/v2) and verifys an apk with a keystore. If the keystore does not exists it uses `fiv_android_keystore` to create a new keystore.
```ruby
# run before signing: ionic cordova build android --prod --release
apk_path =
fiv_sign_android(
keystore_name: 'pizza',
key_alias: 'pizza',
app_version: '1.0.1',
app_build_no: '2020',
apk_output_dir: './apk',
silent: true
)
```
#### Options
| Options | Description | Type | Default | Required |
| -------------------------- | -------------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------- | -------- |
| keystore_path | Path to the android | `string` | `./fastlane/android` | `false` |
| keystore_name | Name of the keystore used to store storepass and keypass in keychain | `string` | | `true` |
| android_sdk_path | Path to your installed Android SDK | `string` | `~/Library/Android/sdk` | `false` |
| android_build_tool_version | Android Build Tool version used for `zipalign`, `sign` and `verify` | `string` | `28.0.3` | `false` |
| apk_source | Android Build Tool version used for `zipalign`, `sign` and `verify` | `string` | `./platforms/android/app/build/outputs/apk/release/app-release-unsigned.apk` | `false` |
| apk_zipalign_target | Target path for the zipaligned apk | `string` | `./platforms/android/app/build/outputs/apk/release/app-release-unsigned-zipalign.apk` | `false` |
| apk_signed_target | Target path of the signed apk | `string` | `./platforms/android/app/build/outputs/apk/release` | `false` |
| key_alias | Key alias of the keystore | `string` | | `true` |
| app_version | App version | `string` | | `true` |
| app_build_no | App build number | `string` | | `true` |
### fiv_update_version
### fiv_update_version_and_build_no
### fiv_version