{"id":20187743,"url":"https://github.com/bitrise-steplib/steps-ionic-archive","last_synced_at":"2025-09-24T16:33:42.419Z","repository":{"id":21337974,"uuid":"92304943","full_name":"bitrise-steplib/steps-ionic-archive","owner":"bitrise-steplib","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-06T12:22:57.000Z","size":573,"stargazers_count":4,"open_issues_count":1,"forks_count":22,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-24T07:52:23.629Z","etag":null,"topics":["bitrise","bitrise-step","ci","production-code"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bitrise-steplib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-24T15:00:18.000Z","updated_at":"2021-11-03T14:13:28.000Z","dependencies_parsed_at":"2024-03-08T06:33:05.599Z","dependency_job_id":null,"html_url":"https://github.com/bitrise-steplib/steps-ionic-archive","commit_stats":null,"previous_names":["bitrise-community/steps-ionic-archive"],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-ionic-archive","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-ionic-archive/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-ionic-archive/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitrise-steplib%2Fsteps-ionic-archive/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitrise-steplib","download_url":"https://codeload.github.com/bitrise-steplib/steps-ionic-archive/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248173826,"owners_count":21059595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitrise","bitrise-step","ci","production-code"],"created_at":"2024-11-14T03:25:48.359Z","updated_at":"2025-09-24T16:33:37.374Z","avatar_url":"https://github.com/bitrise-steplib.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ionic archive\n\n[![Step changelog](https://shields.io/github/v/release/bitrise-steplib/steps-ionic-archive?include_prereleases\u0026label=changelog\u0026color=blueviolet)](https://github.com/bitrise-steplib/steps-ionic-archive/releases)\n\nGenerates builds for the requested platforms.\n\n\u003cdetails\u003e\n\u003csummary\u003eDescription\u003c/summary\u003e\n\nGenerates an iOS, Android or an iOS and Android build based on your Step settings and a `build.json` file which is inherited from the **Generate cordova build configuration** Step.\n\n### Configuring the Step\n1. In the **Platform to use in ionic-cli commands** input, select the platform you wish to build for from the drop-down menu.\n2. In the **Build command configuration** input, select either `debug` or `release` mode from the drop-down menu. If you set `release` to generate a release build, then you should select `device` instead of `emulator` in the **Build command target**.\n3. Select either `emulator` or `device` in the **Build command target** field.\n4. Make sure the file path set in the **Working directory** is pointing to the path where your project's code got downloaded to.\nIf you're using any services of the Ionic framework which requires login credentials, you have to provide those in the **Ionic username** and **Ionic password** inputs. Don't worry, these are stored as secret Environment Variables.\nIf you wish to to modify your native projects by inserting the **Ionic Prepare** Step before the **Ionic Archive** Step, then make sure you set the **Should `ionic cordova prepare` be executed before `ionic cordova build`?** input to `false` in the **Ionic Archive** Step.\nThe **Build configuration path to describe code signing properties** input is automatically filled out with the output Environment Variable of the **Generate cordova build configuation** Step. You do not need to modify this input.\n\n### Troubleshooting\nMake sure you add the **Ionic Archive** Step AFTER the **Generate cordova build configuration** Step as the latter generates the build config file which the **Ionic Archive** Step uses to successfully build an iOS and/or Android project.\nMake sure you insert the **Ionic Archive** Step BEFORE any deploy Step.\nNote that if you’re building for both iOS and Android in one workflow, and either of your apps fails, the whole **Ionic Archive** Step will fail.\nIf you set the **Build configuration** input in the **Generate Cordova Build Configuration** Step to `release`, then you need to use the release configuration in the **Ionic Archive** Step as well.\n\n### Useful links\n- [Getting started with Ionic/Cordova apps on Bitrise](https://devcenter.bitrise.io/code-signing/android-code-signing/android-code-signing-using-bitrise-sign-apk-step/)\n- [Secret Environment Variables on Bitrise](https://devcenter.bitrise.io/builds/env-vars-secret-env-vars/)\n- [Ionic framework](https://ionicframework.com/)\n\n### Related Steps\n- [Generate Cordova Build Configuration](https://www.bitrise.io/integrations/steps/android-build)\n- [Run npm command](https://www.bitrise.io/integrations/steps/npm)\n- [Cordova Archive](https://www.bitrise.io/integrations/steps/cordova-archive)\n\u003c/details\u003e\n\n## 🧩 Get started\n\nAdd this step directly to your workflow in the [Bitrise Workflow Editor](https://devcenter.bitrise.io/steps-and-workflows/steps-and-workflows-index/).\n\nYou can also run this step directly with [Bitrise CLI](https://github.com/bitrise-io/bitrise).\n\n## ⚙️ Configuration\n\n\u003cdetails\u003e\n\u003csummary\u003eInputs\u003c/summary\u003e\n\n| Key | Description | Flags | Default |\n| --- | --- | --- | --- |\n| `platform` | Specify this input to apply ionic-cli commands to desired platforms only.  `ionic cordova build [OTHER_PARAMS] \u003cplatform\u003e` | required | `ios,android` |\n| `configuration` | Specify build command configuration.  `ionic cordova build [OTHER_PARAMS] [--release \\| --debug]` | required | `release` |\n| `target` | Specify build command target.  `ionic cordova build [OTHER_PARAMS] [--device \\| --emulator]` | required | `device` |\n| `build_config` | Path to the build configuration file (build.json), which describes code signing properties. |  | `$BITRISE_CORDOVA_BUILD_CONFIGURATION` |\n| `options` | Use this input to specify custom options, to append to the end of the ionic-cli build command.  Cordova now supports the new build system made default in XCode 10 (https://github.com/apache/cordova-ios/issues/407). To use the legacy build system add `-- --buildFlag=\"-UseModernBuildSystem=0\"` to the options string.  Example: - `--browserify`  `ionic cordova build [OTHER_PARAMS] [options]` |  |  |\n| `ionic_username` | Use `Ionic username` and `Ionic password` to login with ionic-cli. | sensitive |  |\n| `ionic_password` | Use `Ionic username` and `Ionic password` to login with ionic-cli. | sensitive |  |\n| `ionic_version` | The version of ionic you want to use.  If value is set to `latest`, the step will update to the latest ionic version. Leave this input empty to use the preinstalled ionic version. |  |  |\n| `run_ionic_prepare` | It should be set to false if ionic-prepare step is used.  - false: `ionic cordova build` - true: `ionic cordova prepare --no-build` followed by `ionic cordova build` |  | `true` |\n| `cordova_version` | The version of cordova you want to use.  If value is set to `latest`, the step will update to the latest cordova version. Leave this input empty to use the preinstalled cordova version. |  |  |\n| `workdir` | Root directory of your Ionic project, where your Ionic config.xml exists. | required | `$BITRISE_SOURCE_DIR` |\n| `android_app_type` | Set the distribution type that you want to build for your Android app.  | required | `apk` |\n| `cache_local_deps` | Select if the contents of node_modules directory should be cached. `true`: Mark local dependencies to be cached. `false`: Do not use cache.  | required | `false` |\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eOutputs\u003c/summary\u003e\n\n| Environment Variable | Description |\n| --- | --- |\n| `BITRISE_IPA_PATH` |  |\n| `BITRISE_APP_DIR_PATH` |  |\n| `BITRISE_APP_PATH` |  |\n| `BITRISE_DSYM_DIR_PATH` |  |\n| `BITRISE_DSYM_PATH` |  |\n| `BITRISE_APK_PATH` |  |\n| `BITRISE_APK_PATH_LIST` |  |\n| `BITRISE_AAB_PATH` | This output will include the path of the generated AAB. If the build generates more than one AAB this output will contain the last one's path. |\n| `BITRISE_AAB_PATH_LIST` | This output will include the paths of the generated AABs. The paths are separated with `\\|` character, for example, `app--debug.aab\\|app-mips-debug.aab` |\n\u003c/details\u003e\n\n## 🙋 Contributing\n\nWe welcome [pull requests](https://github.com/bitrise-steplib/steps-ionic-archive/pulls) and [issues](https://github.com/bitrise-steplib/steps-ionic-archive/issues) against this repository.\n\nFor pull requests, work on your changes in a forked repository and use the Bitrise CLI to [run step tests locally](https://devcenter.bitrise.io/bitrise-cli/run-your-first-build/).\n\n**Note:** this step's end-to-end tests (defined in `e2e/bitrise.yml`) are working with secrets which are intentionally not stored in this repo. External contributors won't be able to run those tests. Don't worry, if you open a PR with your contribution, we will help with running tests and make sure that they pass.\n\nLearn more about developing steps:\n\n- [Create your own step](https://devcenter.bitrise.io/contributors/create-your-own-step/)\n- [Testing your Step](https://devcenter.bitrise.io/contributors/testing-and-versioning-your-steps/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitrise-steplib%2Fsteps-ionic-archive","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitrise-steplib%2Fsteps-ionic-archive","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitrise-steplib%2Fsteps-ionic-archive/lists"}