diff --git a/docs/environment-variables/appcircle-specific-environment-variables.md b/docs/environment-variables/appcircle-specific-environment-variables.md index c3b59168a..e6d335027 100644 --- a/docs/environment-variables/appcircle-specific-environment-variables.md +++ b/docs/environment-variables/appcircle-specific-environment-variables.md @@ -82,7 +82,7 @@ For more information on the inputs of the steps and how the variables in the fol | AC_ANDROID_ALIAS | Selected alias name. | | AC_ANDROID_ALIAS_PASSWORD | Selected alias password. | | AC_V2_SIGN | Specifies if signing will use V2. | -| AC_ANDROID_POST_PROCESS_OUTPUT_PATH | Path to the output file generated by the [Android Post-Processing](/workflows/android-specific-workflow-steps/post-processor) step. | +| AC_ANDROID_POST_PROCESS_OUTPUT_PATH | Path to the output file generated by the [Android Post-Processing](/workflows/android-specific-workflow-steps/app-post-processor) step. | | JAVA_HOME | Directory path of the Java JDK installation. | | JAVA_OPTS | Options for Java arguments. For example: `-Xms1536M -Xmx9216M` | | JAVA_VERSION | Version of the Java JDK installed. | diff --git a/docs/workflows/android-specific-workflow-steps/android-build-for-ui-testing.md b/docs/workflows/android-specific-workflow-steps/android-build-for-ui-testing.md index 62549c231..eb5f7f692 100644 --- a/docs/workflows/android-specific-workflow-steps/android-build-for-ui-testing.md +++ b/docs/workflows/android-specific-workflow-steps/android-build-for-ui-testing.md @@ -1,7 +1,7 @@ --- title: Android Build for UI Testing description: Learn how to use the Android Build for UI Testing workflow step in Appcircle -tags: [android, mobile, android, ui testing, testing] +tags: [android, mobile, ui testing, testing] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,53 +12,59 @@ The **Android Build for UI Testing** workflow step is tailored to [build your An ### Prerequisites -The workflow steps that need to be executed before running the **Android Build for UI Testing** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Android Build for UI Testing** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | To initiate the **Android Build for UI Testing** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Build for UI Testing** step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | To initiate the **Android Build for UI Testing** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `$AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Build for UI Testing** step. | :::caution + If you're updating the version via Appcircle, ensure that the following step comes before the **Android Build for UI Testing** step: -- [**Android Increment Build and Version Number**](https://docs.appcircle.io/workflows/android-specific-workflow-steps/increment-build-and-version-number) +- [**Android Increment Build and Version Number**](/workflows/android-specific-workflow-steps/increment-build-and-version-number) ::: :::caution + If you're working with a **React Native Android** project, ensure that the following steps come before the **Android Build for UI Testing** step: -- [**Install Node**](https://docs.appcircle.io/workflows/react-native-specific-workflow-steps/#install-node) -- [**NPM/Yarn Commands**](https://docs.appcircle.io/workflows/react-native-specific-workflow-steps/npm-yarn-commands) +- [**Install Node**](/workflows/react-native-specific-workflow-steps/node-install) +- [**NPM/Yarn Commands**](/workflows/react-native-specific-workflow-steps/npm-yarn-commands) ::: :::note -The **[Firebase Test Lab for Android](https://docs.appcircle.io/continuous-testing/firebase-test-lab-for-android/)** step has been added as an example. You can use the APK you produce for UI testing in any component you choose. + +The **[Firebase Test Lab for Android](/workflows/android-specific-workflow-steps/firebase-test-lab)** step has been added as an example. You can use the APK you produce for UI testing in any component you choose. + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Android Build for UI Testing** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) step, the variable will be automatically populated. | Required | -| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | +| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](/workflows/common-workflow-steps/git-clone) step, the variable will be automatically populated. | Required | +| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | | `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. | Optional | ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | ------------------- | -------------------------------------------------------------------------------------------------------------------- | -| `$AC_APK_PATH` | Path for the generated **APK** file. This path will be created after the **Android Build for UI Testing** step runs. | -| `$AC_TEST_APK_PATH` | Path for the generated `*androidTest.apk` file. This output can be utilized wherever necessary for UI testing. | +| `AC_APK_PATH` | Path for the generated **APK** file. This path will be created after the **Android Build for UI Testing** step runs. | +| `AC_TEST_APK_PATH` | Path for the generated `*androidTest.apk` file. This output can be utilized wherever necessary for UI testing. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/android-specific-workflow-steps/android-build.md b/docs/workflows/android-specific-workflow-steps/android-build.md index 617bcf5d6..ebb01a533 100644 --- a/docs/workflows/android-specific-workflow-steps/android-build.md +++ b/docs/workflows/android-specific-workflow-steps/android-build.md @@ -1,7 +1,7 @@ --- title: Android Build description: Learn how to use the Android Build workflow step in Appcircle -tags: [android, mobile, android, build] +tags: [android, mobile, android build, build] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,30 +12,31 @@ The Appcircle Android Build step is designed to build your Android application f ### Prerequisites -The workflow steps that need to be executed before running the **Android Build** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Android Build** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Git Clone](/workflows/common-workflow-steps/#git-clone) | To initiate the Android build process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the Git Clone step, it generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the Android Build step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | To initiate the Android build process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the Git Clone step, it generates the `$AC_REPOSITORY_DIR` variable, which is then used as the input for the Android Build step. | ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Android Build** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](/workflows/common-workflow-steps/#git-clone) step, the variable will be automatically populated. | Required | -| `$AC_MODULE` | This variable specifies the project module to be build. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration/). In Android Studio, you can locate the available modules for your project. For more information, please refer to [this Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | -| `$AC_VARIANTS` | This variable specifies the project variant to be build. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration/). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | -| `$AC_OUTPUT_TYPE` | This variable specifies the output type for your build file (APK or AAB). This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration/). | Required | +| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](/workflows/common-workflow-steps/git-clone) step, the variable will be automatically populated. | Required | +| `$AC_MODULE` | This variable specifies the project module to be build. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can locate the available modules for your project. For more information, please refer to [this Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | +| `$AC_VARIANTS` | This variable specifies the project variant to be build. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | +| `$AC_OUTPUT_TYPE` | This variable specifies the output type for your build file (APK or AAB). This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). | Required | | `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. | Optional | | `$AC_GRADLE_BUILD_EXTRA_ARGS` | Extra arguments were passed to build task. For more information, please refer to [this Gradle document](https://docs.gradle.org/current/userguide/writing_build_scripts.html#sec:extra_properties). | Optional | :::info + If you have filled in the necessary variables in the **Configuration** section, you will not need to redefine these variables again in the Workflow. For more information about configurations, refer to the [Build Profile Configuration Overview](/build/build-process-management/build-profile-configuration) document. The information you fill in the configuration will be used as input in the Android Build step. Please replace the example information with your own details: @@ -43,35 +44,44 @@ If you have filled in the necessary variables in the **Configuration** section, 1. The input corresponding to the 1st field: `$AC_MODULE` 2. The input corresponding to the 2nd field: `$AC_VARIANTS` 3. The input corresponding to the 3rd field: `$AC_OUTPUT_TYPE` + ::: :::tip + If you are using Gradle 4.3 and above in your project, you can just use the `--scan` flag in the build step to enable build scans. For existing projects, you may need to add the Gradle Scan (Gradle Enterprise) plugin. For more information, please refer to https://scans.gradle.com/ + ::: ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | -------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| `$AC_APK_PATH` | Path for the generated **APK** file. This path will be created after the **Android Build** step runs. | -| `$AC_AAB_PATH` | Path for the generated **AAB** file. This path will be created after the Android Build step runs and when `AAB` is selected. | +| `AC_APK_PATH` | Path for the generated **APK** file. This path will be created after the **Android Build** step runs. | +| `AC_AAB_PATH` | Path for the generated **AAB** file. This path will be created after the Android Build step runs and when `AAB` is selected. | The resulting files will be either APK or AAB, depending on whether you choose the Android App in the project [Configuration](/build/build-process-management/build-profile-configuration). If your project has the [signing configuration](https://developer.android.com/studio/build/gradle-tips#sign-your-app) in Gradle, this step will generate a signed artifact. :::caution + If you do not disable the **Android Sign** step and your project has no signing configuration defined in Gradle, your artifact will remain unsigned. So, in order to sign your app using the keystore selected in the build configuration, you should enable the **Android Sign** step after **Android Build**. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-android-build-component.git +--- + ## FAQ ### How can I solve the `Out of memory error: Java heap memory` or set the heap memory during the build? diff --git a/docs/workflows/android-specific-workflow-steps/android-dependency-report.md b/docs/workflows/android-specific-workflow-steps/android-dependency-report.md index ae3b1d1ae..ad5698fd1 100644 --- a/docs/workflows/android-specific-workflow-steps/android-dependency-report.md +++ b/docs/workflows/android-specific-workflow-steps/android-dependency-report.md @@ -1,7 +1,7 @@ --- title: Android Dependency Report description: Learn how to use the Android Dependency Report workflow step in Appcircle -tags: [android, mobile, android, report] +tags: [android, mobile, dependency, report] --- import Screenshot from '@site/src/components/Screenshot'; @@ -14,41 +14,45 @@ Rendering the dependency tree is particularly useful if you’d like to identify ### Prerequisites -The workflow steps that need to be executed before running the **Android Dependency Report** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Android Dependency Report** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | To initiate the **Android Dependency Report** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Dependency Report** step. | +| [**Git Clone**](/build/build-process-management/build-profile-configuration) | To initiate the **Android Dependency Report** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Dependency Report** step. | ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Android Dependency Report** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) step, the variable will be automatically populated. | Required | -| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | +| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](/build/build-process-management/build-profile-configuration) step, the variable will be automatically populated. | Required | +| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | | `$AC_DEPENDENCY_CONFIGURATION` | Specifies the [configuration](https://docs.gradle.org/current/userguide/declaring_dependencies.html#sec:what-are-dependency-configurations) to resolve for displaying dependency information. The default value is: `implementation`. | Required | | `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. The default value is: `./` | Optional | ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | ------------------------------------ | ---------------------------------------------------------------------- | -| `$AC_ANDROID_DEPENDENCY_REPORT_PATH` | Specifies the path where the Android dependency report file is stored. | +| `AC_ANDROID_DEPENDENCY_REPORT_PATH` | Specifies the path where the Android dependency report file is stored. | :::danger -If you wish to review or download the Android Dependencies Report, you can find them directly from [**Download Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts/#download-exported-artifacts). To do this, please ensure that the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps#export-build-artifacts) step follows the **Android Dependency Report** workflow step. + +If you wish to review or download the **Android Dependencies Report**, you can find them directly from [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts). To do this, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step follows the **Android Dependency Report** workflow step. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-dependency-report.git diff --git a/docs/workflows/android-specific-workflow-steps/android-sign.md b/docs/workflows/android-specific-workflow-steps/android-sign.md index 3d788d51e..e34cee521 100644 --- a/docs/workflows/android-specific-workflow-steps/android-sign.md +++ b/docs/workflows/android-specific-workflow-steps/android-sign.md @@ -11,29 +11,37 @@ import Screenshot from '@site/src/components/Screenshot'; **Android Sign** step signs your *APK* or *AAB* with the given Android *keystore* and exports a binary file compatible with Android devices. :::info -This step follows the [**Android Build**](https://docs.appcircle.io/workflows/android-specific-workflow-steps#android-build) step to sign the unsigned build output if the project doesn't include a *keystore*. If your project includes a *keystore*, the build application step will generate a signed artifact. If you do not disable this step, your artifact will be unsigned and then re-signed using the *keystore* selected in the **Configuration** or in this step. + +This step follows the [**Android Build**](/workflows/android-specific-workflow-steps/android-build) step to sign the unsigned build output if the project doesn't include a *keystore*. If your project includes a *keystore*, the build application step will generate a signed artifact. If you do not disable this step, your artifact will be unsigned and then re-signed using the *keystore* selected in the **Configuration** or in this step. + ::: ### Prerequisites -The workflow steps that need to be executed before running the **Android Build** workflow step, along with their respective reasons, are listed in the table below. + +Before running the **Android Sign** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | This step relies on the **Android Build** step and the **Git Clone** step is necessary for the **Android Build** step to run successfully. | -| [Android Build](https://docs.appcircle.io/workflows/android-specific-workflow-steps#android-build) | The app required for this step is generated by the **Android Build** (or alternative build steps). | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step relies on the **Android Build** step and the **Git Clone** step is necessary for the **Android Build** step to run successfully. | +| [**Android Build**](/workflows/android-specific-workflow-steps/android-build) | The app required for this step is generated by the **Android Build** (or alternative build steps). | :::caution + If a step other than the **Android Build** step is used to build an app, then the **Android Sign** step depends on this step. + ::: :::danger -To share the signed apps created as an output of this step or to view them on the **Download Artifacts** page, please ensure that the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/#export-build-artifacts) step is included in your workflow after this step. + +To share the signed apps created as an output of this step or to view them on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your workflow after this step. + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Android Sign** are as follows: + +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -41,26 +49,31 @@ For each component, specific input variables are required for its operation on y |-----------------------------|----------------------------------------------|--------| | `$AC_APK_PATH` | The path of the *APK* file. This path is automatically generated in the **Android Build** step. You may need to modify this input variable to provide a different path. | Required | | `$AC_AAB_PATH` | The path of the *AAB* file. This path is automatically generated in the **Android Build** step. You may need to modify this input variable to provide a different path. | Required | -| `$AC_ANDROID_KEYSTORE_PATH` | *Keystore* file can be selected in the **Configuration**. This value will be auto-generated depending on your *keystore* file selection in [signing configuration on Appcircle](https://docs.appcircle.io/build/building-android-applications#signing). | Required | +| `$AC_ANDROID_KEYSTORE_PATH` | *Keystore* file can be selected in the **Configuration**. This value will be auto-generated depending on your *keystore* file selection in [signing configuration on Appcircle](/build/platform-build-guides/building-android-applications#signing). | Required | | `$AC_ANDROID_KEYSTORE_PASSWORD` | Password for the selected *keystore* file. This value will be auto-generated based on your *keystore* file selection. | Required | | `$AC_ANDROID_ALIAS` | Alias name for the selected *keystore* file. This value will be auto-generated depending on your **Configuration** | | `$AC_ANDROID_ALIAS_PASSWORD` | Alias password for the selected *keystore* file. This value will be auto-generated depending on your **Configuration** | | `$AC_V2_SIGN` | Defaults to false. Set true if the signature should be done using apksigner instead of jarsigner. For more information, [Apps targeting Android 11 require APK Signature Scheme v2](https://developer.android.com/about/versions/11/behavior-changes-11#minimum-signature-scheme). | Optional | ### Output Variables -The outputs that can result from the operation of this component are listed as follows. + +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | |------------------------|---------------------------------------------| -| `$AC_SIGNED_APK_PATH` | Path for the signed *APK* file output. If an *APK* file is provided as input, the signed app will also be in *APK* format. | -| `$AC_SIGNED_AAB_PATH` | Path for the signed App Bundle file output. If an *AAB* file is provided as input, the signed app will also be in *AAB* format. | +| `AC_SIGNED_APK_PATH` | Path for the signed *APK* file output. If an *APK* file is provided as input, the signed app will also be in *APK* format. | +| `AC_SIGNED_AAB_PATH` | Path for the signed App Bundle file output. If an *AAB* file is provided as input, the signed app will also be in *AAB* format. | :::tip + If both input value types (*AAB* and *APK*) are provided, the same type of signed app will be generated for both. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-android-sign-component.git diff --git a/docs/workflows/android-specific-workflow-steps/android-unit-tests.md b/docs/workflows/android-specific-workflow-steps/android-unit-tests.md index 9a1705475..6bcdf4862 100644 --- a/docs/workflows/android-specific-workflow-steps/android-unit-tests.md +++ b/docs/workflows/android-specific-workflow-steps/android-unit-tests.md @@ -1,7 +1,7 @@ --- title: Android Unit Tests description: Learn how to use the Android Unit Tests workflow step in Appcircle -tags: [android, mobile, android, testing] +tags: [android, mobile, unit, testing] --- import Screenshot from '@site/src/components/Screenshot'; @@ -10,44 +10,48 @@ import Screenshot from '@site/src/components/Screenshot'; The **Android Unit Tests** workflow step executes the unit tests within your project, ensuring comprehensive test coverage. The results of these tests will be included in the artifact archive for further analysis and review. -Please check out this document for more information: [Running Android Unit Tests](https://docs.appcircle.io/continuous-testing/android-testing/running-android-unit-tests) +Please check out this document for more information: [Running Android Unit Tests](/continuous-testing/android-testing/running-android-unit-tests) ### Prerequisites -The workflow steps that need to be executed before running the **Android Unit Tests** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Android Unit Tests** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | To initiate the **Android Unit Tests** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Unit Tests** step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | To initiate the **Android Unit Tests** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `$AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Unit Tests** step. | :::danger -If you wish to view the test results on Appcircle's Test Reports page, it is essential to use the [Test Reports](https://github.com/appcircleio/appcircle-test-report-component) step after the **Android Unit Tests**. Please check out this document for more information: [Generating Test Report](https://docs.appcircle.io/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) + +If you wish to view the test results on Appcircle's Test Reports page, it is essential to use the [Test Reports for Android](/workflows/android-specific-workflow-steps/test-reports-for-android) step after the **Android Unit Tests**. Please check out this document for more information: [Generating Test Report](/continuous-testing/android-testing/running-android-unit-tests#generating-test-report). + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Android Unit Tests** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) step, the variable will be automatically populated. | Required | -| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | -| `$AC_VARIANTS` | This variable specifies the project variant to be built. This variable can also be set via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | -| `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. The default value is: `./` | Optional | +| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](/workflows/common-workflow-steps/git-clone) step, the variable will be automatically populated. | Required | +| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | +| `$AC_VARIANTS` | This variable specifies the project variant to be built. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | +| `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. The default value is: `./`. | Optional | ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | ---------------------- | -------------------------------------------------------------- | -| `$AC_TEST_RESULT_PATH` | Specifies the directory where your JUnit XML report is stored. | +| `AC_TEST_RESULT_PATH` | Specifies the directory where your JUnit XML report is stored. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/android-specific-workflow-steps/app-center-android-distribution.md b/docs/workflows/android-specific-workflow-steps/app-center-android-distribution.md index c8c4cb9f2..7b2396e05 100644 --- a/docs/workflows/android-specific-workflow-steps/app-center-android-distribution.md +++ b/docs/workflows/android-specific-workflow-steps/app-center-android-distribution.md @@ -1,7 +1,7 @@ --- title: App Center Android Distribute description: App Center Android Distribute enables developers to distribute their Android applications to testers and stakeholders for testing purposes. -tags: [android, mobile, distribution] +tags: [android, mobile, distribution, app center] --- import Screenshot from '@site/src/components/Screenshot'; @@ -13,41 +13,46 @@ import Screenshot from '@site/src/components/Screenshot'; The Appcircle **App Center Android Distribute** step allows you to seamlessly distribute your Android applications and mapping files to [App Center](https://appcenter.ms). :::caution + Please note that you can also distribute your app via Appcircle. Utilizing Appcircle's distribution modules enhances manageability within the platform. For more details, please refer to the following links: -- [Appcircle Testing Distribution](https://docs.appcircle.io/distribute/) -- [Appcircle Enterprise App Store](https://docs.appcircle.io/enterprise-app-store/) -- [Appcircle Publish](https://docs.appcircle.io/publish-module/) +- [Appcircle Testing Distribution](/testing-distribution) +- [Appcircle Enterprise App Store](/enterprise-app-store) +- [Appcircle Publish](/publish-module) ::: ### Prerequisites -The workflow steps that need to be executed before running the **App Center Android Distribute** workflow step, along with their respective reasons, are listed in the table below. +Before running the **App Center Android Distribute** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [Android Build](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-build) | The app required for this step is generated by the Android Build (or alternative build steps). | -| [Android Sign](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. If your app is already signed in the build step, you can skip this step. | +| [**Android Build**](/workflows/android-specific-workflow-steps/android-build) | The app required for this step is generated by the Android Build (or alternative build steps). | +| [**Android Sign**](/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. If your app is already signed in the build step, you can skip this step. | :::danger + If a step other than the **Android Build** or **Android Sign** step is used to build or sign the app, then the **App Center Android Distribute** step depends on this step. + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for **App Center Android Distribute** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger -**Do not hard-code sensitive variables, such as tokens and API keys, directly to the parameters in the step.** +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. -We recommend using [Environment Variables](https://docs.appcircle.io/environment-variables/) groups for such sensitive variables. ::: | Variable Name | Description | Status | @@ -58,8 +63,8 @@ We recommend using [Environment Variables](https://docs.appcircle.io/environment | `$AC_APPCENTER_APPNAME` | The name of the app is in the App Center. The app's name can be identified in its URL, such as `https://appcenter.ms/users/JohnDoe/apps/myapp` for a user-owned app (where **myapp** is the app name) and `https://appcenter.ms/orgs/Appcircle/apps/myapp` for an org-owned app (the owner is **myapp**). | Required | | `$AC_APPCENTER_GROUPS` | Specifies the group names in the App Center. For more than one group name to be distributed, you must separate them with a comma. For example: `group0,group1,..,groupn` | Optional | | `$AC_APPCENTER_STORE` | Specifies the store name. For example: `App Store`, `Google Play`, and `Intune`. | Optional | -| `$AC_APPCENTER_RELEASE_NOTES_PATH` | Specifies the release note path. If you use the [**Publishing Release Notes**](https://docs.appcircle.io/workflows/common-workflow-steps/publish-release-notes) component before this step, `release-notes.txt` will be used as release notes. The default value is `AC_OUTPUT_DIR/release-notes.txt`. | Optional | -| `$AC_APPCENTER_MAPPING_PATH` | Specifies the path of the `mapping.txt` file. Example: `$AC_REPOSITORY_DIR/build/app/outputs/mapping/release/mapping.txt` | Optional | +| `$AC_APPCENTER_RELEASE_NOTES_PATH` | Specifies the release note path. If you use the [**Publishing Release Notes**](/workflows/common-workflow-steps/publish-release-notes) component before this step, `release-notes.txt` will be used as release notes. The default value is `AC_OUTPUT_DIR/release-notes.txt`. | Optional | +| `$AC_APPCENTER_MAPPING_PATH` | Specifies the path of the `mapping.txt` file. Example: `$AC_REPOSITORY_DIR/build/app/outputs/mapping/release/mapping.txt`. | Optional | | `$AC_APPCENTER_MANDATORY` | Specifies whether the update should be considered mandatory. The options are `true` and `false`. The default value is `false`. | Optional | | `$AC_APPCENTER_NOTIFY` | Notify testers of this release. The options are `true` and `false`. The default value is `false`. | Optional | | `$AC_APPCENTER_VERSION` | [App Center CLI](https://learn.microsoft.com/tr-tr/appcenter/cli/) version. The latest version will be used if no version is set. | Optional | diff --git a/docs/workflows/android-specific-workflow-steps/app-post-processor.md b/docs/workflows/android-specific-workflow-steps/app-post-processor.md index 5f54d0514..0365de64f 100644 --- a/docs/workflows/android-specific-workflow-steps/app-post-processor.md +++ b/docs/workflows/android-specific-workflow-steps/app-post-processor.md @@ -10,29 +10,36 @@ import Screenshot from '@site/src/components/Screenshot'; This step performs the necessary system operations to identify and process the Android output binary files. :::warning + This step also verifies whether the app is signed or not. If this step is not included in your Workflow or if it is determined that there is no signed app as a result of this step, __the app cannot be distributed__. + ::: ### Prerequisites + The workflow steps that need to be executed before running the **Android App Post-Processor** workflow step, along with their respective reasons, are listed in the table below. | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | This step relies on the **Android Build** step and the **Git Clone** step is necessary for the **Android Build** step to run successfully. | -| [Android Build](/workflows/android-specific-workflow-steps/android-build) | To process Android output, these outputs must be obtained from the build step. | -| [Android Sign](/workflows/android-specific-workflow-steps/android-sign) | If a signed app is created, this step needs to be run beforehand to process this output. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step relies on the **Android Build** step and the **Git Clone** step is necessary for the **Android Build** step to run successfully. | +| [**Android Build**](/workflows/android-specific-workflow-steps/android-build) | To process Android output, these outputs must be obtained from the build step. | +| [**Android Sign**](/workflows/android-specific-workflow-steps/android-sign) | If a signed app is created, this step needs to be run beforehand to process this output. | :::caution + If a step other than the **Android Build** or **Android Sign** step is used to build or sign the app, then the **Android App Post-Processor** step depends on this step. + ::: ### Input Variables + There is no need to enter an input for this component. It will process Android files under the output directory (`$AC_OUTPUT_DIR`). ### Output Variables -The outputs that can result from the operation of this component are listed as follows: + +The output(s) resulting from the operation of this component are as follows: @@ -41,6 +48,7 @@ The outputs that can result from the operation of this component are listed as f | `$AC_ANDROID_POST_PROCESS_OUTPUT_PATH` | Specifies the application post process file path. This file specifies the base name for each app and whether it is signed or not. | :::info + The output post-processing JSON file should adhere to the following structure: ```jsx title="ac_post_process_output.json" [ @@ -51,10 +59,13 @@ The output post-processing JSON file should adhere to the following structure: {...} ] ``` + ::: :::caution + To share the signed apps created as a result of this step or to view them on the **Download Artifacts** page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your Workflow after this step. + ::: --- diff --git a/docs/workflows/android-specific-workflow-steps/appdome-build-to-secure-for-android.md b/docs/workflows/android-specific-workflow-steps/appdome-build-to-secure-for-android.md index 1e226a99a..821262858 100644 --- a/docs/workflows/android-specific-workflow-steps/appdome-build-to-secure-for-android.md +++ b/docs/workflows/android-specific-workflow-steps/appdome-build-to-secure-for-android.md @@ -1,7 +1,7 @@ --- title: Appdome Build-2Secure for Android description: Appdome Build-2Secure automates the integration of advanced security features, adaptive protections, code-signing, and certification processes into mobile applications, enhancing security without the need for manual coding or code analysis. -tags: [android, mobile, security, appdome] +tags: [android, mobile, security, build, appdome] --- import Screenshot from '@site/src/components/Screenshot'; @@ -16,27 +16,33 @@ https://appcircle.io/blog/elevate-your-mobile-app-security-with-appdome-integrat ### Prerequisites -The workflow steps that need to be executed before running the **Appdome Build-2Secure for Android** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Appdome Build-2Secure for Android** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [Android Build](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-build) | The app required for this step is generated by the **Android Build** (or alternative build steps). | -| [Android Sign](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. If your app is already signed in the build step, you can skip this step. | +| [**Android Build**](/workflows/android-specific-workflow-steps/android-build) | The app required for this step is generated by the **Android Build** (or alternative build steps). | +| [**Android Sign**](/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. If your app is already signed in the build step, you can skip this step. | :::danger + If a step other than the **Android Build** or **Android Sign** step is used to build or sign the app, then the **Appdome Build-2Secure for Android** step depends on this step. + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for **Appdome Build-2Secure for Android** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::caution -Confidential information should be entered as a [secret environment variable](https://docs.appcircle.io/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, ensure that the [environment variable group](https://docs.appcircle.io/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. + ::: | Variable Name | Description | Status | @@ -53,16 +59,16 @@ Confidential information should be entered as a [secret environment variable](ht ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `$AC_APPDOME_SECURED_APK_PATH` | Specified path of the secured APK file produced by **Appdome Build-2Secure**. This is available when the `Signing Method` is set to `On-Appdome` or `Private-Signing`. | -| `$AC_APPDOME_SECURED_AAB_PATH` | Specified path of the secured AAB file produced by **Appdome Build-2Secure**. This is available when the `Signing Method` is set to `On-Appdome` or `Private-Signing`. | -| `$AC_APPDOME_PRIVATE_SIGN_SCRIPT_PATH` | Specified path of the `.sh` sign script file produced by **Appdome Build-2Secure**. This is available when the `Signing Method` is set to `Auto-Dev-Signing`. | -| `$AC_APPDOME_CERTIFICATE_PATH` | Specified path of the [**_Certified Secure_**](https://www.appdome.com/certified-secure-mobile-devsecops-certification/) certificate produced by **Appdome Build-2Secure** for your app is provided as a PDF file. | +| `AC_APPDOME_SECURED_APK_PATH` | Specified path of the secured APK file produced by **Appdome Build-2Secure**. This is available when the `Signing Method` is set to `On-Appdome` or `Private-Signing`. | +| `AC_APPDOME_SECURED_AAB_PATH` | Specified path of the secured AAB file produced by **Appdome Build-2Secure**. This is available when the `Signing Method` is set to `On-Appdome` or `Private-Signing`. | +| `AC_APPDOME_PRIVATE_SIGN_SCRIPT_PATH` | Specified path of the `.sh` sign script file produced by **Appdome Build-2Secure**. This is available when the `Signing Method` is set to `Auto-Dev-Signing`. | +| `AC_APPDOME_CERTIFICATE_PATH` | Specified path of the [**_Certified Secure_**](https://www.appdome.com/certified-secure-mobile-devsecops-certification/) certificate produced by **Appdome Build-2Secure** for your app is provided as a PDF file. | --- diff --git a/docs/workflows/android-specific-workflow-steps/appsweep-mobile-security-testing.md b/docs/workflows/android-specific-workflow-steps/appsweep-mobile-security-testing.md index f050e4b1a..42448e363 100644 --- a/docs/workflows/android-specific-workflow-steps/appsweep-mobile-security-testing.md +++ b/docs/workflows/android-specific-workflow-steps/appsweep-mobile-security-testing.md @@ -1,7 +1,7 @@ --- title: AppSweep Mobile Security Testing description: Learn how to use the AppSweep Mobile Security Testing workflow step in Appcircle -tags: [android, mobile, android, security, testing, app sweep] +tags: [android, mobile, security, testing, appsweep] --- import Screenshot from '@site/src/components/Screenshot'; @@ -14,39 +14,41 @@ The Appcircle **AppSweep Mobile Security Testing** step allows you to comprehens ### Prerequisites -The workflow steps that need to be executed before running the **AppSweep Mobile Security Testing** workflow step, along with their respective reasons, are listed in the table below. +Before running the **AppSweep Mobile Security Testing** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | The **AppSweep Mobile Security Testing** step requires the repository to be cloned from the Git provider before it can function properly. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The **AppSweep Mobile Security Testing** step requires the repository to be cloned from the Git provider before it can function properly. | ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for **AppSweep Mobile Security Testing** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger -**Do not hard-code sensitive variables, such as tokens and API keys, directly to the parameters in the step.** +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. -We recommend using [Environment Variables](https://docs.appcircle.io/environment-variables/) groups for such sensitive variables. ::: | Variable Name | Description | Status | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | | `$AC_APPSWEEP_API_KEY` | Specifies the API key of the AppSweep account. You can create an API key in the API Keys section of your project settings on the AppSweep website. | Required | -| `$AC_APPSWEEP_VARIANT` | Specifies the project variant to be built. This variable can also be set via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | +| `$AC_APPSWEEP_VARIANT` | Specifies the project variant to be built. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | | `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. | Optional | ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | ------------------ | ------------------------------------------------------------- | -| `$AC_APPSWEEP_URL` | A direct link to the scan results is on the AppSweep website. | +| `AC_APPSWEEP_URL` | A direct link to the scan results is on the AppSweep website. | --- diff --git a/docs/workflows/android-specific-workflow-steps/azure-bot-for-detekt-report.md b/docs/workflows/android-specific-workflow-steps/azure-bot-for-detekt-report.md index dd8a334a8..83fb8abe7 100644 --- a/docs/workflows/android-specific-workflow-steps/azure-bot-for-detekt-report.md +++ b/docs/workflows/android-specific-workflow-steps/azure-bot-for-detekt-report.md @@ -1,7 +1,7 @@ --- title: Azure DevOps Bot for Detekt Report description: The Azure DevOps Bot for Detekt Report step analyze your Detekt report and post the report details within the opened pull request in Azure DevOps. -tags: [detekt report, analysis] +tags: [detekt, report, azure devops, bot, analysis] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,7 +12,7 @@ The **Azure DevOps Bot for Detekt Report** step analyzes your [Detekt report](ht :::caution -[Danger](https://danger.systems/) operates on a similar principle, allowing use of the [Danger step](https://docs.appcircle.io/workflows/common-workflow-steps/#code-reviews-with-danger) with platforms such as [GitHub](https://github.com/), [GitLab](https://about.gitlab.com/), and [Bitbucket](https://bitbucket.org/product/guides/getting-started/overview#a-brief-overview-of-bitbucket). However, Danger currently does not support Azure DevOps. +[Danger](https://danger.systems/) operates on a similar principle, allowing use of the [Danger step](/workflows/common-workflow-steps/danger) with platforms such as [GitHub](https://github.com/), [GitLab](https://about.gitlab.com/), and [Bitbucket](https://bitbucket.org/product/guides/getting-started/overview#a-brief-overview-of-bitbucket). However, Danger currently does not support Azure DevOps. For more information, refer to the Appcircle blog post about Danger: - [**Danger in CI: Automate Your Mobile Code Reviews**](https://appcircle.io/blog/danger-in-ci-automate-your-mobile-code-reviews). @@ -21,22 +21,25 @@ For more information, refer to the Appcircle blog post about Danger: ### Prerequisites -The workflow steps that need to be executed before running the **Azure DevOps Bot for Detekt Report** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Azure DevOps Bot for Detekt Report** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|--------------------------------------------------| - | [Detekt](https://docs.appcircle.io/workflows/android-specific-workflow-steps/#detekt) | In order to generate the [Detekt report](https://detekt.dev/docs/introduction/reporting/), the **Detekt** step must be executed beforehand. | + | [**Detekt**](/workflows/android-specific-workflow-steps/detekt) | In order to generate the [Detekt report](https://detekt.dev/docs/introduction/reporting/), the **Detekt** step must be executed beforehand. | ### Input Variables -For each step, specific input variables are required for its operation on your system. The input variables necessary for the **Azure DevOps Bot for Detekt Report** are as follows: + +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::caution +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. -Enter confidential information as [**secret environment variable**](https://docs.appcircle.io/environment-variables/managing-variables#adding-key-and-text-based-value-pairs) and ensure the appropriate [**environment variable group**](https://docs.appcircle.io/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [Configuration](https://docs.appcircle.io/build/build-profile-configuration/). +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/android-specific-workflow-steps/browserstack-app-automate-espresso.md b/docs/workflows/android-specific-workflow-steps/browserstack-app-automate-espresso.md index 57fe9402b..890cd2b59 100644 --- a/docs/workflows/android-specific-workflow-steps/browserstack-app-automate-espresso.md +++ b/docs/workflows/android-specific-workflow-steps/browserstack-app-automate-espresso.md @@ -1,7 +1,7 @@ --- title: BrowserStack App Automate - Espresso description: BrowserStack App Automate - Espresso is a testing solution provided by BrowserStack specifically designed for Android applications using the Espresso testing framework. -tags: [android, mobile, testing, browserstack] +tags: [android, mobile, testing, espresso, browserstack] --- import Screenshot from '@site/src/components/Screenshot'; @@ -14,26 +14,35 @@ The Appcircle **BrowserStack App Automate - Espresso** step allows you to run au ### Prerequisites -The workflow steps that need to be executed before running the **BrowserStack App Automate - Espresso** workflow step, along with their respective reasons, are listed in the table below. +Before running the **BrowserStack App Automate - Espresso** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Android Build for UI Testing](https://docs.appcircle.io/workflows/android-specific-workflow-steps/#android-build-for-ui-testing) | The **Android Build for UI Testing** step must be executed to obtain the necessary Android app outputs for processing. | +| [**Android Build for UI Testing**](/workflows/android-specific-workflow-steps/android-build-for-ui-testing) | The **Android Build for UI Testing** step must be executed to obtain the necessary Android app outputs for processing. | ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **BrowserStack App Automate - Espresso** are as follows: + +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. + +::: + | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|--------| | `$AC_BROWSERSTACK_USERNAME` | Specifies the username of the BrowserStack account. Refer to [BrowserStack - Authenticate Test Runs](https://www.browserstack.com/docs/automate/cypress/authentication) for more details. | Required | | `$AC_BROWSERSTACK_ACCESS_KEY` | Specifies the access key for the BrowserStack account. Refer to [BrowserStack - Authenticate Test Runs](https://www.browserstack.com/docs/automate/cypress/authentication) for more details. | Required | | `$AC_APK_PATH` | Specifies the path of the **APK** file produced in the Appcircle workflow to be sent to BrowserStack. This field is automatically populated if the **Android Build for UI Testing** step was executed in previous steps. | Required | | `$AC_TEST_APK_PATH` | Specifies the path of the **test APK** file produced in the Appcircle workflow to be sent to BrowserStack. This field is automatically populated if the **Android Build for UI Testing** step was executed in previous steps. | Required | -| `$AC_BROWSERSTACK_PAYLOAD` | Specifies the payload to be sent to BrowserStack from your Appcircle workflow.`AC_BROWSERSTACK_APP_URL` and `AC_BROWSERSTACK_TEST_URL` will be auto generated. Please refer to the [documentation](https://www.browserstack.com/docs/app-automate/api-reference/espresso/builds#execute-a-build) for more details about the payload. | Optional | +| `$AC_BROWSERSTACK_PAYLOAD` | Specifies the payload to be sent to BrowserStack from your Appcircle workflow.`$AC_BROWSERSTACK_APP_URL` and `$AC_BROWSERSTACK_TEST_URL` will be auto generated. Please refer to the [documentation](https://www.browserstack.com/docs/app-automate/api-reference/espresso/builds#execute-a-build) for more details about the payload. | Optional | | `$AC_BROWSERSTACK_TIMEOUT` | Specifies the timeout in seconds for checking the BrowserStack plan. The default value is `600`. | Required | --- diff --git a/docs/workflows/android-specific-workflow-steps/bundle-universal-apk.md b/docs/workflows/android-specific-workflow-steps/bundle-universal-apk.md index b5255d90f..a4ebd0ed4 100644 --- a/docs/workflows/android-specific-workflow-steps/bundle-universal-apk.md +++ b/docs/workflows/android-specific-workflow-steps/bundle-universal-apk.md @@ -1,7 +1,7 @@ --- title: Bundle Universal Apk description: This step creates a universal APK from an AAB file. -tags: [android, mobile, distribution] +tags: [android, mobile, distribution, bundle, aab, apk] --- import Screenshot from '@site/src/components/Screenshot'; @@ -14,22 +14,24 @@ For additional details, please refer to the [**Bundletool**](https://developer.a ### Prerequisites -The workflow steps that need to be executed before running the **Bundle Universal Apk** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Bundle Universal Apk** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | -------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| [Android Build](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-build) | This step is necessary to generate the **AAB** app that will be converted to an **APK**. | -| [Android Sign](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. If your app is already signed in the build step, you can skip this step. | +| [**Android Build**](/workflows/android-specific-workflow-steps/android-build) | This step is necessary to generate the **AAB** app that will be converted to an **APK**. | +| [**Android Sign**](/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. If your app is already signed in the build step, you can skip this step. | :::caution + If a step other than the **Android Build** or **Android Sign** step is used to build or sign the app, then the **Bundle Universal Apk** step depends on this step. + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Bundle Universal Apk** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -37,18 +39,20 @@ For each component, specific input variables are required for its operation on y | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | `$AC_BUNDLETOOL_VERSION` | Specifies the version of **Bundletool** to install. The default value is `1.11.2`. To install a different version, please refer to [this document](https://github.com/google/bundletool/releases). | Required | | `$AC_SIGNED_AAB_PATH` | The optional path of the signed **AAB** file to convert the **APK**. If this step runs after the **Android Sign** step, the variable will be automatically populated. If the signing takes place in the build step and you want to directly enter the **APK** you received from the **Android Build** step here, you can change the variable to `$AC_APK_PATH`. | Required | -| `$AC_ANDROID_KEYSTORE_PATH` | (Autogenerated) The path to the keystore file selected via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). For more details, please refer to the [Android Keystores](https://docs.appcircle.io/signing-identities/android-keystores) documentation. | Required | -| `$AC_ANDROID_KEYSTORE_PASSWORD` | (Autogenerated) The password for the keystore file, generated according to the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). For more details, please refer to the [Android Keystores](https://docs.appcircle.io/signing-identities/android-keystores) documentation. | Required | -| `$AC_ANDROID_ALIAS` | (Autogenerated) The alias for the Android Keystore, generated according to the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). For more details, please refer to the [Android Keystores](https://docs.appcircle.io/signing-identities/android-keystores) documentation. | Required | -| `$AC_ANDROID_ALIAS_PASSWORD` | (Autogenerated) The password for the Android Keystore alias, generated according to the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). For more details, please refer to the [Android Keystores](https://docs.appcircle.io/signing-identities/android-keystores) documentation. | Required | +| `$AC_ANDROID_KEYSTORE_PATH` | (Autogenerated) The path to the keystore file selected via the build [Configuration](/build/build-process-management/build-profile-configuration). For more details, please refer to the [Android Keystores](/signing-identities/android-keystores) documentation. | Required | +| `$AC_ANDROID_KEYSTORE_PASSWORD` | (Autogenerated) The password for the keystore file, generated according to the build [Configuration](/build/build-process-management/build-profile-configuration). For more details, please refer to the [Android Keystores](/signing-identities/android-keystores) documentation. | Required | +| `$AC_ANDROID_ALIAS` | (Autogenerated) The alias for the Android Keystore, generated according to the build [Configuration](/build/build-process-management/build-profile-configuration). For more details, please refer to the [Android Keystores](/signing-identities/android-keystores) documentation. | Required | +| `$AC_ANDROID_ALIAS_PASSWORD` | (Autogenerated) The password for the Android Keystore alias, generated according to the build [Configuration](/build/build-process-management/build-profile-configuration). For more details, please refer to the [Android Keystores](/signing-identities/android-keystores) documentation. | Required | ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | --------------------- | -------------------------------- | -| `$AC_SIGNED_APK_PATH` | Path of the signed **APK** file. | +| `AC_SIGNED_APK_PATH` | Path of the signed **APK** file. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/android-specific-workflow-steps/detekt.md b/docs/workflows/android-specific-workflow-steps/detekt.md index 1cbaedbe2..aabab3c7d 100644 --- a/docs/workflows/android-specific-workflow-steps/detekt.md +++ b/docs/workflows/android-specific-workflow-steps/detekt.md @@ -14,17 +14,17 @@ The Appcircle Detekt step executes the Detekt Gradle task. For further details, ### Prerequisites -Below are the prerequisite workflow steps required before running the **Detekt** step, along with their reasons: +Before running the **Detekt** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/git-clone) | The **Git Clone** step is necessary to fetch the repository before conducting code checks and must precede the **Detekt** step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The **Git Clone** step is necessary to fetch the repository before conducting code checks and must precede the **Detekt** step. | ### Input Variables -Each component requires specific input variables for its operation. The input variables necessary for the **Detekt** step are: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -33,17 +33,17 @@ Each component requires specific input variables for its operation. The input va | `$AC_DETEKT_TASK` | Specifies the name of the Detekt task. The default value is `detekt`. | Required | | `$AC_DETEKT_EXTRA_PARAMETERS` | Additional command-line parameters for Detekt. | Optional | | `$AC_DETEKT_SAVE_REPORT` | Specifies whether the Detekt report will be saved. If set to `true`, report files will be saved into the artifacts folder. The default value is `false`. | Optional | -| `$AC_DETEKT_OUTPUT_PATH` | Specifies the Detekt output path. If the `AC_DETEKT_SAVE_REPORT` input is set to `true` and this value is not defined, then `/build/reports` will be used as the default path. | Optional | +| `$AC_DETEKT_OUTPUT_PATH` | Specifies the Detekt output path. If the `$AC_DETEKT_SAVE_REPORT` input is set to `true` and this value is not defined, then `/build/reports` will be used as the default path. | Optional | :::danger -If `$AC_DETEKT_SAVE_REPORT` is set to `true`, place the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts) step after the **Detekt** step to ensure proper transfer of outputs to the [Download Artifacts](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) section. +If `$AC_DETEKT_SAVE_REPORT` is set to `true`, place the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step after the **Detekt** step to ensure proper transfer of outputs to the [Download Artifacts](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) section. ::: ### Output Variables -The output is not stored in any variable. If `AC_DETEKT_SAVE_REPORT` is set to `true`, the file output will be saved in the `$AC_PROJECT_PATH/$AC_MODULE/build/reports` directory (check these variables on the [Appcircle-Specific Environment Variables](https://docs.appcircle.io/environment-variables/appcircle-specific-environment-variables#ios--android-common-environment-variables) page). If you've added the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts) step after the **Detekt** step, this output will also be accessible in the [Download Artifacts](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) section. +The output is not stored in any variable. If `AC_DETEKT_SAVE_REPORT` is set to `true`, the file output will be saved in the `$AC_PROJECT_PATH/$AC_MODULE/build/reports` directory (check these variables on the [Appcircle-Specific Environment Variables](/environment-variables/appcircle-specific-environment-variables#ios--android-common-environment-variables) page). If you've added the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step after the **Detekt** step, this output will also be accessible in the [Download Artifacts](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) section. --- diff --git a/docs/workflows/android-specific-workflow-steps/firebase-test-lab.md b/docs/workflows/android-specific-workflow-steps/firebase-test-lab.md index a20a145ac..c621c98e2 100644 --- a/docs/workflows/android-specific-workflow-steps/firebase-test-lab.md +++ b/docs/workflows/android-specific-workflow-steps/firebase-test-lab.md @@ -12,11 +12,11 @@ Appcircle is integrated with the [Firebase Test Lab](https://firebase.google.com ## Prerequisites -The necessary workflow steps to execute before running the **Firebase Test Lab for Android** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Firebase Test Lab for Android** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Android Build for UI Testing](./android-build-for-ui-testing) | The **Android Build for UI Testing** step must be executed to obtain the necessary Android application outputs for processing. | +| [**Android Build for UI Testing**](/workflows/android-specific-workflow-steps/android-build-for-ui-testing) | The **Android Build for UI Testing** step must be executed to obtain the necessary Android application outputs for processing. | In addition to the steps you need to run on Appcircle, there are also adjustments you need to make on the Firebase Test Lab side. These adjustments can be made as follows: @@ -61,10 +61,18 @@ If you want to use the UI Test Build output or the Signed Build output in the Fi ## Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Android Build for UI Testing** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. + +::: + | Variable Name | Description | Status | |---------------------------|----------------------------------------------------|----------| | `$AC_FIREBASE_PROJECT_ID` | Specifies the name of the Firebase project created. | Optional | diff --git a/docs/workflows/android-specific-workflow-steps/gradle-runner.md b/docs/workflows/android-specific-workflow-steps/gradle-runner.md index db68aca3a..94729d229 100644 --- a/docs/workflows/android-specific-workflow-steps/gradle-runner.md +++ b/docs/workflows/android-specific-workflow-steps/gradle-runner.md @@ -12,25 +12,25 @@ The **Gradle Runner** workflow step executes the specified [Gradle task](https:/ ### Prerequisites -The workflow steps that need to be executed before running the **Gradle Runner** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Gradle Runner** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | To initiate the **Gradle Runner** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the **Gradle Runner** step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | To initiate the **Gradle Runner** process, the repository that needs to be built must be fetched from the branch. This is achieved as follows: Upon completion of the **Git Clone** step, it generates the `$AC_REPOSITORY_DIR` variable, which is then used as the input for the **Gradle Runner** step. | ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Gradle Runner** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) step, the variable will be automatically populated. | Required | -| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | -| `$AC_VARIANTS` | This variable specifies the project variant to be built. This variable can also be set via the build [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | +| `$AC_REPOSITORY_DIR` | This variable represents the path of the cloned Git repository. If this step runs after the [Git Clone](/workflows/common-workflow-steps/git-clone) step, the variable will be automatically populated. | Required | +| `$AC_MODULE` | This variable specifies the project module to be built. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can locate the available modules for your project. For more information, please refer to this [Android document](https://developer.android.com/studio/projects#ApplicationModules). | Required | +| `$AC_VARIANTS` | This variable specifies the project variant to be built. This variable can also be set via the build [Configuration](/build/build-process-management/build-profile-configuration). In Android Studio, you can find the available variants for your project. For more information, please refer to this [Android document](https://developer.android.com/build/build-variants). | Required | | `$AC_OUTPUT_DIR` | Specifies the directory path for the generated app files. | Required | | `$AC_GRADLE_TASK` | Specifies the name of the Gradle task. Refer to the documentation for detailed information: [List available tasks](https://docs.gradle.org/current/userguide/tutorial_using_tasks.html#list_available_tasks). | Required | | `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. The default value is: `./` | Optional | @@ -41,9 +41,13 @@ For each component, specific input variables are required for its operation on y As the output may vary depending on the task you execute, there is no specific output defined by default. :::caution -If there is an output generated, ensure to use the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps#export-build-artifacts) step afterward to ensure it is included in the [**Download Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts/#download-exported-artifacts) page. + +If there is an output generated, ensure to use the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step afterward to ensure it is included in the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) page. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-android-gradle-task-component.git diff --git a/docs/workflows/android-specific-workflow-steps/increment-build-and-version-number.md b/docs/workflows/android-specific-workflow-steps/increment-build-and-version-number.md index c041ec412..ae79534e4 100644 --- a/docs/workflows/android-specific-workflow-steps/increment-build-and-version-number.md +++ b/docs/workflows/android-specific-workflow-steps/increment-build-and-version-number.md @@ -14,6 +14,7 @@ The **Android Increment Build and Version Number** step is managed with **Androi - [**Understanding Android Versioning**](/versioning/android-version) +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/android-specific-workflow-steps/index.md b/docs/workflows/android-specific-workflow-steps/index.md index 56e9eb66f..4ad8f37a9 100644 --- a/docs/workflows/android-specific-workflow-steps/index.md +++ b/docs/workflows/android-specific-workflow-steps/index.md @@ -159,8 +159,7 @@ This step runs given Gradle task. This component provides detailed reports and insights on the results of Android app tests conducted. For detailed information on the usage of **Test Reports for Android**, please refer to the documentation: -[https://docs.appcircle.io/continuous-testing/android-testing/running-android-unit-tests#generating-test-report](https://docs.appcircle.io/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) - +- [Generating Test Report](/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) Test Reports for Android diff --git a/docs/workflows/android-specific-workflow-steps/lint.md b/docs/workflows/android-specific-workflow-steps/lint.md index b5e2074ba..8d36cb01d 100644 --- a/docs/workflows/android-specific-workflow-steps/lint.md +++ b/docs/workflows/android-specific-workflow-steps/lint.md @@ -14,21 +14,23 @@ This step is used to run Lint Gradle tasks in your project via Appcircle. ### Prerequisites -The workflow steps that need to be executed before running the **Android Lint** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Android Lint** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Git Clone](/workflows/common-workflow-steps/git-clone) | To start the **Android Lint** process, the repository that needs to be built must be fetched from the branch. This generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Lint** step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | To start the **Android Lint** process, the repository that needs to be built must be fetched from the branch. This generates the `$AC_REPOSITORY_DIR` variable, which is then used as the input for the **Android Lint** step. | :::caution + Please ensure that you insert the **Android Lint** step before using the **Android Build** step. + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Android Lint** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -40,6 +42,7 @@ For each component, specific input variables are required for its operation on y | `$AC_PROJECT_PATH` | Specifies the project path. If your project that needs to be built is **not located** in the root directory where it was cloned from Git, you should provide the subpath as a relative path. | Optional | :::info + If you have filled in the required variables in the **Configuration** section, you will not need to redefine these variables again on the [**Workflows**](/workflows/). For more information about configurations, refer to the [Build Profile Configuration Overview](/build/build-process-management/build-profile-configuration) document. @@ -51,7 +54,7 @@ If you have filled in the required variables in the **Configuration** section, y ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: @@ -60,7 +63,9 @@ The outputs that can result from the operation of this component are listed as f | `-` | Lint does not assign the XML/HTML file output to a variable. However, the resulting file from **Lint** appears in the output (`$AC_OUTPUT_DIR`) and report directory (`/$AC_MODULE/build/reports`). | :::caution + To view the Lint report on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts/#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps#export-build-artifacts) step is included in your **Workflow** after this step. + ::: --- diff --git a/docs/workflows/android-specific-workflow-steps/post-processor.md b/docs/workflows/android-specific-workflow-steps/post-processor.md deleted file mode 100644 index 0b37e218f..000000000 --- a/docs/workflows/android-specific-workflow-steps/post-processor.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Android App Post-Processor -description: This step performs the necessary system operations to identify and process the Android output binary files. -tags: [android, mobile, post processor] ---- - -import Screenshot from '@site/src/components/Screenshot'; - -# Android App Post-Processor -This step performs the necessary system operations to identify and process the Android output binary files. - -:::danger -This step also verifies whether the app is signed or not. If this step is not included in your Workflow or if it is determined that there is no signed app as a result of this step, __the app cannot be distributed__. -::: - -### Prerequisites -The workflow steps that need to be executed before running the **Android App Post-Processor** workflow step, along with their respective reasons, are listed in the table below. - -| Prerequisite Workflow Step | Description | -|-------------------------------------------------|-------------------------------------------------| -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | This step relies on the **Android Build** step and the **Git Clone** step is necessary for the **Android Build** step to run successfully. | -| [Android Build](https://docs.appcircle.io/workflows/android-specific-workflow-steps#android-build) | To process Android output, these outputs must be obtained from the build step. | -| [Android Sign](https://docs.appcircle.io/workflows/android-specific-workflow-steps#android-sign) | If a signed app is created, this step needs to be run beforehand to process this output. | - - - -:::caution -If a step other than the **Android Build** or **Android Sign** step is used to build or sign the app, then the **Android App Post-Processor** step depends on this step. -::: - -### Input Variables -There is no need to enter an input for this component. It will process Android files under the output directory (`$AC_OUTPUT_DIR`). - -### Output Variables -The outputs that can result from the operation of this component are listed as follows: - - - -| Variable Name | Description | -|----------------------------------------|---------------------------------------------------| -| `$AC_ANDROID_POST_PROCESS_OUTPUT_PATH` | Specifies the application post process file path. This file specifies the base name for each app and whether it is signed or not. | - -:::info -The output post-processing JSON file should adhere to the following structure: -```jsx title="ac_post_process_output.json" -[ - { - "signed": true|false, - "app_name": "app base name" - }, - {...} -] -``` -::: - -:::caution -To share the signed apps created as a result of this step or to view them on the **Download Artifacts** page, please ensure that the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps#export-build-artifacts) step is included in your Workflow after this step. -::: - ---- -To access the source code of this component, please use the following link: - -https://github.com/appcircleio/appcircle-android-build-component.git \ No newline at end of file diff --git a/docs/workflows/android-specific-workflow-steps/test-reports-for-android.md b/docs/workflows/android-specific-workflow-steps/test-reports-for-android.md index 7a8496cf2..d56edfaad 100644 --- a/docs/workflows/android-specific-workflow-steps/test-reports-for-android.md +++ b/docs/workflows/android-specific-workflow-steps/test-reports-for-android.md @@ -17,11 +17,12 @@ This component supports the following test and coverage formats: - [**Cobertura**](https://cobertura.github.io/cobertura) - [**lcov.info**](https://lcov-viewer.netlify.app) -For additional details, please refer to the document: [**Generating Test Report**](https://docs.appcircle.io/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) +For additional details, please refer to the document: +- [**Generating Test Report**](/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) ### Prerequisites -Before executing the **Test Report** workflow step, certain prerequisite workflow steps must be completed: +Before running the **Test Reports for Android** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------ | ----------------------------------------------------------------------------- | @@ -32,20 +33,20 @@ Before executing the **Test Report** workflow step, certain prerequisite workflo ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for **Test Reports** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ------------------------ | ---------------------------------------------------------------- | --------- | -| `AC_TEST_RESULT_PATH` | Specifies the directory and its subdirectories where compatible test files will be searched. | Required | -| `AC_COVERAGE_RESULT_PATH`| Specifies the coverage path. | Optional | -| `AC_JACOCO_COVERAGE_TYPE`| Determines the parameter in your JaCoCo report based on which the coverage will be calculated. This setting is necessary when using JaCoCo parseable coverage results and specifying the coverage result path. Types description can be found in this [documentation](/continuous-testing/android-testing/running-android-unit-tests#jacoco-test-coverage) | Required | +| `$AC_TEST_RESULT_PATH` | Specifies the directory and its subdirectories where compatible test files will be searched. | Required | +| `$AC_COVERAGE_RESULT_PATH`| Specifies the coverage path. | Optional | +| `$AC_JACOCO_COVERAGE_TYPE`| Determines the parameter in your JaCoCo report based on which the coverage will be calculated. This setting is necessary when using JaCoCo parseable coverage results and specifying the coverage result path. Types description can be found in this [documentation](/continuous-testing/android-testing/running-android-unit-tests#jacoco-test-coverage) | Required | ### Output Variables -The outputs resulting from the operation of this component are as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | -------------------------- | ---------------------------------------------------- | diff --git a/docs/workflows/android-specific-workflow-steps/wait-for-android-emulator.md b/docs/workflows/android-specific-workflow-steps/wait-for-android-emulator.md index b4f03da7e..5cdc5ec4a 100644 --- a/docs/workflows/android-specific-workflow-steps/wait-for-android-emulator.md +++ b/docs/workflows/android-specific-workflow-steps/wait-for-android-emulator.md @@ -10,40 +10,46 @@ import Screenshot from '@site/src/components/Screenshot'; The **Wait for Android Emulator** step waits for the Android Emulator to boot. You must use this step before running any UI tests. -For additional details, please refer to the [**Emulator**](https://docs.appcircle.io/infrastructure/android-build-infrastructure/#emulator) documentation. +For additional details, please refer to the [**Emulator**](/infrastructure/android-build-infrastructure#emulator) documentation. :::danger -Ensure that you select the **Appcircle Linux Pool (x86_64)** in the Configuration tab, as the **Wait for Android Emulator** step will not function in the **Appcircle Standard macOS Pool (arm64)**. Please refer to [this documentation](https://docs.appcircle.io/build/build-process-management/build-profile-configuration/#project-details-configuration) for selecting a pool in Configuration. + +Ensure that you select the **Appcircle Linux Pool (x86_64)** in the Configuration tab, as the **Wait for Android Emulator** step will not function in the **Appcircle Standard macOS Pool (arm64)**. Please refer to [this documentation](/build/build-process-management/build-profile-configuration/#project-details-configuration) for selecting a pool in Configuration. + ::: ### Prerequisites -The workflow steps that need to be executed before running the **Wait for Android Emulator** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Wait for Android Emulator** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Android Build](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-build) | This step is necessary to obtain the Android outputs required for processing. Without adding this step beforehand, the **Wait for Android Emulator** step will still function, but the app will not be installed. | -| [Android Sign](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. Failure to add this step beforehand will result in the **Wait for Android Emulator** step still functioning, but since the app is not signed, there may be installation issues. If your app is already signed, you can skip this step. | +| [**Android Build**](/workflows/android-specific-workflow-steps/android-build) | This step is necessary to obtain the Android outputs required for processing. Without adding this step beforehand, the **Wait for Android Emulator** step will still function, but the app will not be installed. | +| [**Android Sign**](/workflows/android-specific-workflow-steps/android-sign) | If you intend to use a signed app, this step must be executed beforehand to process the output. Failure to add this step beforehand will result in the **Wait for Android Emulator** step still functioning, but since the app is not signed, there may be installation issues. If your app is already signed, you can skip this step. | :::caution + If a step other than the **Android Build** or **Android Sign** step is used to build or sign the app, then the **Wait for Android Emulator** step depends on this step. + ::: ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for the **Wait for Android Emulator** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_TEST_DEVICE` | Specifies the device for the test. The default value is `Pixel_3a`. If you use an emulator other than `Pixel_3a`, you need to create it manually. To install a different device, please follow [this document](https://docs.appcircle.io/infrastructure/android-build-infrastructure/#emulator). | Required | +| `$AC_TEST_DEVICE` | Specifies the device for the test. The default value is `Pixel_3a`. If you use an emulator other than `Pixel_3a`, you need to create it manually. To install a different device, please follow [this document](/infrastructure/android-build-infrastructure#emulator). | Required | | `$AC_TEST_ADB_WAIT_SECONDS` | Specifies the number of seconds the component must wait for the emulator to boot. The default value is `300`. | Optional | | `$AC_TEST_ADB_ARGUMENTS` | ADB arguments for the device. For additional details about ADB arguments, please refer to the [Android Debug Bridge](https://developer.android.com/tools/adb) documentation. The default value is: `-no-window -no-audio -no-boot-anim -netdelay none -no-snapshot -wipe-data -gpu auto`. You may add new arguments, but don't change the default ones, such as `no-window`. | Required | | `$AC_SIGNED_APK_PATH` | The optional full path of the signed APK file to install after the emulator boots. If this step runs after the **Android Sign** step, the variable will be automatically populated. If the signing takes place in the build step and you want to directly enter the APK you received from the **Android Build** step here, you can change the variable to `$AC_APK_PATH`. | Optional | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-android-wait-emulator.git diff --git a/docs/workflows/common-workflow-steps/active-ssh-private-key.md b/docs/workflows/common-workflow-steps/active-ssh-private-key.md index 6a588246f..66aab0e73 100644 --- a/docs/workflows/common-workflow-steps/active-ssh-private-key.md +++ b/docs/workflows/common-workflow-steps/active-ssh-private-key.md @@ -12,9 +12,11 @@ This step sets up your SSH key in the build machine if you used one to connect y ### Prerequisites +There are no prerequisites required before using the **Active SSH Private Key** step. + :::caution -If you connect to your repository via SSH, use this step before the [Git Clone](/workflows/common-workflow-steps/git-clone) step. To securely clone repositories connected via SSH, you must define the SSH key for the relevant build agent. +If you connect to your repository via SSH, use this step before the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. To securely clone repositories connected via SSH, you must define the SSH key for the relevant build agent. @@ -22,17 +24,26 @@ If you connect to your repository via SSH, use this step before the [Git Clone]( ### Input Variables -Below are the parameters required for this step, along with detailed explanations. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_REPOSITORY_SSH_KEY` | SSH private key in RSA format. This value defaults to `AC_REPOSITORY_SSH_KEY`. It is automatically defined as the [**Reserved Environment Variables**](/environment-variables/appcircle-specific-environment-variables) when an SSH connection is made. | Optional | +| `$AC_REPOSITORY_SSH_KEY` | SSH private key in RSA format. This value defaults to `$AC_REPOSITORY_SSH_KEY`. It is automatically defined as the [**Reserved Environment Variables**](/environment-variables/appcircle-specific-environment-variables) when an SSH connection is made. | Optional | ### Output Variables +The output(s) resulting from the operation of this component are as follows: + + | Variable Name | Description | |-------------------------------|------------------------------------------------| -| `$SSH_AUTH_SOCK` | This is the path to the SSH Auth Socket. | \ No newline at end of file +| `SSH_AUTH_SOCK` | This is the path to the SSH Auth Socket. | + +--- + +To access the source code of this component, please use the following link: + +https://github.com/appcircleio/appcircle-activate-ssh-key-component \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/add-badge-app-icon.md b/docs/workflows/common-workflow-steps/add-badge-app-icon.md index 8cc1dfd91..a92f86a8d 100644 --- a/docs/workflows/common-workflow-steps/add-badge-app-icon.md +++ b/docs/workflows/common-workflow-steps/add-badge-app-icon.md @@ -17,11 +17,11 @@ With Appcircle's **Add Badge to Your App Icon** component, you can add badges an ### Prerequisites -Below is a list of workflow steps that need to be executed before this step, along with their respective reasons. +Before running the **Add a Badge to Your App Icon** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | The repository needs to be cloned to begin the badge-adding process. After this step, the variable `AC_REPOSITORY_DIR` will be set. | +| [**Git Clone**](/workflows/common-workflow-steps#git-clone) | The repository needs to be cloned to begin the badge-adding process. After this step, the variable `$AC_REPOSITORY_DIR` will be set. | :::caution @@ -34,7 +34,7 @@ If you are using the [**Increment Build and Version Number**](/versioning/ios-ve ### Input Variables -Below is a list of input variables that can be used with this component with a description of each. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -61,6 +61,8 @@ To use this component, you must provide the icon path from your project file. He ::: -For the source code of this component, visit: +--- + +To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-badge-component diff --git a/docs/workflows/common-workflow-steps/appium-server.md b/docs/workflows/common-workflow-steps/appium-server.md index bcf2b5eef..4f7d3dcd3 100644 --- a/docs/workflows/common-workflow-steps/appium-server.md +++ b/docs/workflows/common-workflow-steps/appium-server.md @@ -1,7 +1,7 @@ --- title: Appium Server description: Enhance your app testing with Appium Server. Automate mobile app testing across platforms for better efficiency and accuracy in development. -tags: [testing, automation, server, cli, development] +tags: [testing, automation, server, cli, development, appium] --- @@ -15,11 +15,7 @@ You can easily integrate the **Appium CLI** into your pipeline using Appcircle's ### Prerequisites -:::info - -This step does not require any specific components to function. You can place it anywhere within your pipeline according to your workflow needs. - -::: +There are no prerequisites required before using the **Appium Server** step. ### Input Variables @@ -29,4 +25,10 @@ Below is a list of input variables that can be used with this component, with a | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_APPIUM_VERSION` | Specifies the version of Appium Server to install, such as `v1.22.3`. If you do not specify a version, the system installs the latest version. | Optional | \ No newline at end of file +| `$AC_APPIUM_VERSION` | Specifies the version of Appium Server to install, such as `v1.22.3`. If you do not specify a version, the system installs the latest version. | Optional | + +--- + +To access the source code of this component, please use the following link: + +https://github.com/appcircleio/appcircle-appium-component \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/authenticate-with-netrc.md b/docs/workflows/common-workflow-steps/authenticate-with-netrc.md index af32bc388..057c6556f 100644 --- a/docs/workflows/common-workflow-steps/authenticate-with-netrc.md +++ b/docs/workflows/common-workflow-steps/authenticate-with-netrc.md @@ -12,22 +12,26 @@ The `.netrc` file contains login and initialization information used by the auto ### Prerequisites -There is no mandatory step before the **Authenticate with Netrc** step. +There are no prerequisites required before using the **Authenticate with Netrc** step. :::danger + Please note that you should use this step before your **Git Clone** step. If you want to connect to a repository that requires access permission or pull a private dependency, please pay attention to the step order. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). :::danger -When using the **Authenticate with Netrc** component, you need to specify a token or password in the `$AC_NETRC_PASS` parameter within the component. For security reasons, we recommend using [**Enviroment Variables**](https://docs.appcircle.io/environment-variables/) in steps where you need to specify the token and password. + +When using the **Authenticate with Netrc** component, you need to specify a token or password in the `$AC_NETRC_PASS` parameter within the component. For security reasons, we recommend using [**Enviroment Variables**](/environment-variables) in steps where you need to specify the token and password. + ::: | Variable Name | Description | Status | @@ -36,6 +40,8 @@ When using the **Authenticate with Netrc** component, you need to specify a toke | `$AC_NETRC_USER` | Specifies the username of the host. | Required | | `$AC_NETRC_PASS` | The password or the `authentication-token`/`access-token` in the respective field, will be used by the host to authenticate you. | Required | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-netrc-component diff --git a/docs/workflows/common-workflow-steps/aws-device-farm-and-deploy.md b/docs/workflows/common-workflow-steps/aws-device-farm-and-deploy.md index 3a3cee471..ba2a422f1 100644 --- a/docs/workflows/common-workflow-steps/aws-device-farm-and-deploy.md +++ b/docs/workflows/common-workflow-steps/aws-device-farm-and-deploy.md @@ -1,7 +1,7 @@ --- title: AWS Device Farm and Deploy description: AWS Device Farm is an application testing service that enables you to run your tests concurrently on multiple mobile devices to speed up the execution of your tests and generates videos and logs to help you quickly identify issues with your app. -tags: [android, ios, mobile, testing, aws] +tags: [android, ios, mobile, testing, aws, device, farm] --- import Screenshot from '@site/src/components/Screenshot'; @@ -18,7 +18,7 @@ The full details of the tests are accessible in the [AWS Device Farm console](ht ### Prerequisites -This component works separately for iOS and Android. It depends on different steps for both platforms. +Before running the **AWS Device Farm and Deploy** step, you must complete certain prerequisites, as detailed in the table below: :::caution @@ -28,8 +28,8 @@ Pay attention to the dependent step on whichever platform you are working on. | Prerequisite Workflow Step | Description | | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Android Build for UI Testing](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-build-for-ui-testing) | The Android Build for UI Testing workflow step is tailored to build your Android test application using Gradle Wrapper (gradlew) for the designated architectures outlined in your project. | -| [Xcodebuild Build for Testing](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/build-and-test/xcodebuild-for-testing) | This step builds your application and generates an IPA for testing so that it can be used in test automation frameworks. | +| [**Android Build for UI Testing**](/workflows/android-specific-workflow-steps/android-build-for-ui-testing) | This step is tailored to build your Android test application using Gradle Wrapper (gradlew) for the designated architectures outlined in your project. | +| [**Xcodebuild Build for Testing**](/workflows/ios-specific-workflow-steps/xcodebuild-for-testing) | This step builds your application and generates an IPA for testing so that it can be used in test automation frameworks. | #### For iOS @@ -41,15 +41,15 @@ Pay attention to the dependent step on whichever platform you are working on. ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -**Do not hard-code sensitive variables, such as tokens and API keys, directly to the parameters in the step.** +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. -We recommend using [Environment Variables](/environment-variables/) groups for such sensitive variables. +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -109,12 +109,16 @@ The full details of the tests are accessible in the [AWS Device Farm console](ht ### Output Variables +The outputs resulting from the operation of this component are as follows: + | Variable Name | Description | | ---------------------------- | ---------------------------- | -| `$AWS_RUN_ARN` | AWS Device Farm Run ARN. | -| `$AWS_TEST_RESULT` | AWS Device Farm Test result. | -| `$AWS_OUTPUT_DEVICEPOOL_ARN` | The ARN of the Device pool. | -| `$AWS_OUTPUT_APPUPLOAD_ARN` | The ARN of the App Upload. | +| `AWS_RUN_ARN` | AWS Device Farm Run ARN. | +| `AWS_TEST_RESULT` | AWS Device Farm Test result. | +| `AWS_OUTPUT_DEVICEPOOL_ARN` | The ARN of the Device pool. | +| `AWS_OUTPUT_APPUPLOAD_ARN` | The ARN of the App Upload. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/azure-board.md b/docs/workflows/common-workflow-steps/azure-board.md index d210bacd7..9751fcb44 100644 --- a/docs/workflows/common-workflow-steps/azure-board.md +++ b/docs/workflows/common-workflow-steps/azure-board.md @@ -16,15 +16,17 @@ You can use the [Azure Boards Component](https://github.com/appcircleio/appcircl ### Prerequisites -There is no mandatory sequence for the use of this component. It depends on your business decision which step to use before or after in your workflow. +There are no prerequisites required before using the **Azure Boards** step. It depends on your business decision which step to use before or after in your workflow. :::caution -Please note that once the Azure Boards component has run successfully, the status of the relevant article in your Azure Board account will be changed. If the build fails in Appcircle, an incorrect status may appear in your Azure Board account. Make sure you use it in the correct order in Workflow. + +Please note that once the **Azure Boards** component has run successfully, the status of the relevant article in your Azure Board account will be changed. If the build fails in Appcircle, an incorrect status may appear in your Azure Board account. Make sure you use it in the correct order in Workflow. + ::: ### Configuration of Component -To add a comment, the issue ID `AC_AZUREBOARD_WORKITEM` must be supplied to the component. We need to get this issue ID dynamically so that our workflow can work for multiple branches. Appcircle components use environment variables to pass the state. We can add a step just before the Azure Boards component to prepare the necessary environment variables. +To add a comment, the issue ID `$AC_AZUREBOARD_WORKITEM` must be supplied to the component. We need to get this issue ID dynamically so that our workflow can work for multiple branches. Appcircle components use environment variables to pass the state. We can add a step just before the Azure Boards component to prepare the necessary environment variables. Let's say you're working on a feature branch called feature/onboarding-1. You may use the below Ruby script to get issue ID 1 from the branch name and use this information with the Azure Boards component. Please see the [**Custom Script step documentation**](/workflows/common-workflow-steps/upload-files-to-amazon-s3) for this implementation. @@ -41,14 +43,16 @@ open(env_var_path, 'a') { |f| ### Input Variables -There are some necessary parameters for this stepper to work properly. These parameters are given in the table below with their explanations. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger -**Do not hard-code sensitive variables, such as tokens and API keys, directly to the parameters in the step.** +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. -We recommend using [Environment Variables](/environment-variables/) groups for such sensitive variables. ::: | Variable Name | Description | Status | @@ -65,7 +69,9 @@ We recommend using [Environment Variables](/environment-variables/) groups for s | `$AC_AZUREBOARD_TEMPLATE` | This comment template will be used to post a comment. Variables donated with `$` will be replaced during the build. Please check [this document](https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/work-items/update?view=azure-devops-rest-7.0) to learn more about possible updates. | Required | :::tip -If you add state names for successful and failed steps (`AC_AZUREBOARD_FAIL_STATE` and `AC_AZUREBOARD_SUCCESS_STATE`), the Azure Boards component will automatically change the status of your issue according to the state of your workflow. + +If you add state names for successful and failed steps (`$AC_AZUREBOARD_FAIL_STATE` and `$AC_AZUREBOARD_SUCCESS_STATE`), the Azure Boards component will automatically change the status of your issue according to the state of your workflow. + ::: ### Changing Template @@ -74,6 +80,8 @@ Appcircle provides a default template that adds the commit ID, branch name, and Please check the [Azure Boards Component](https://github.com/appcircleio/appcircle-azure-boards-component/) documentation for more information. +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-azure-boards-component/ diff --git a/docs/workflows/common-workflow-steps/build-cache/cache-pull.md b/docs/workflows/common-workflow-steps/build-cache/cache-pull.md index 481e42626..f9879d963 100644 --- a/docs/workflows/common-workflow-steps/build-cache/cache-pull.md +++ b/docs/workflows/common-workflow-steps/build-cache/cache-pull.md @@ -11,10 +11,13 @@ import Screenshot from '@site/src/components/Screenshot'; [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) uploads the cache archive file to a remote location, as we explained in detail in the **Cache Push** step. On the other hand, **Cache Pull** downloads and extracts that archive file in the build pipeline, restoring all files and folders to their original locations. :::danger + [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) and **Cache Pull** components should work in coordination on the same cache file. Therefore, to download the pushed cache, the **Cache Pull** must have the same cache label as the **Cache Push**. + ::: :::info + If you need to use the cached folder in a different branch or a separate project, you have the capability to modify the values of `$AC_GIT_BRANCH` or `$AC_BUILD_PROFILE_ID`. For further information, please check out the following documentation: - [How to Share Files Between Pipelines](/workflows/common-workflow-steps/build-cache/how-to-share-file-between-pipelines) - [How to Share Files Between Build Profiles](/workflows/common-workflow-steps/build-cache/how-to-share-file-between-build-profiles) @@ -22,32 +25,39 @@ If you need to use the cached folder in a different branch or a separate project These variables can be adjusted within the [cache label](#input-variables) field, as indicated by the red highlight in the accompanying image. Simply replace them with the branch or project ID that corresponds to your intended usage. + ::: ### Prerequisites +There are no prerequisites required before using the **Cache Pull** step. + :::caution + This component does not require any prerequisite steps for operation. The only thing necessary for the component to work as expected is to utilize the cached files before the step in which they will be used. Additionally, an important prerequisite for this step to function properly is that the files to be used must have been cached in previous builds. -For example, in the screenshot, to use cached files for Cocoapods, the **Cache Pull** step should be used before the [**Cocoapods Install**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/cocoapods-install) step. +For example, in the screenshot, to use cached files for Cocoapods, the **Cache Pull** step should be used before the [**Cocoapods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) step. + ::: :::danger + If there are no previously cached files and you attempt to use this step, the **Cache Pull** step will result in a **`not found error`** because it cannot locate the specified files at the remote location. + ::: ### Input Variables -The parameters required for the operation of this step are given in the list below with their descriptions. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |----------------------------|------------------------------------------------|--------| | `$AC_CACHE_LABEL` | User defined cache label to identify one cache from others. Both [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) and **Cache Pull** steps should have the same value to match. | Required | -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository path. This path will be generated after running the [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/git-clone) step. | Optional | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository path. This path will be generated after running the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Optional | --- diff --git a/docs/workflows/common-workflow-steps/build-cache/cache-push.md b/docs/workflows/common-workflow-steps/build-cache/cache-push.md index b9de53c72..b01146434 100644 --- a/docs/workflows/common-workflow-steps/build-cache/cache-push.md +++ b/docs/workflows/common-workflow-steps/build-cache/cache-push.md @@ -21,33 +21,43 @@ When you drag and drop the **Cache Push** component into your [workflow](/workfl If you need more paths to cache or need to change paths according to your project, you can customize [included](#input-variables) and [excluded](#input-variables) paths as you wish. All path updates will be reflected in the archived cache file on your next build. :::danger + You cannot delete a specific cache file from the UI, but if you have a problem with a cache file and need a fresh one, you can change your [cache label](#input-variables) to a new one to go on with a clean cache. + ::: :::info + The system automatically cleans unreachable and obsolete cache files periodically. For this reason, **it's not guaranteed to reach a previously used cache file by using the previous cache label in build**. Also, it’s a good idea to build your workflow in such a way that your **build won’t fail if the cache can’t be accessed**. + ::: ### Prerequisites +Before running the **Cache Push** step, you must complete certain prerequisites, as detailed in the table below: + | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/git-clone) | If the folders to be cached are in the repo directory, the **Git Clone** step must be used before. This step will generate the [`AC_REPOSITORY_DIR`](#input-variables) path. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | If the folders to be cached are in the repo directory, the **Git Clone** step must be used before. This step will generate the [`$AC_REPOSITORY_DIR`](#input-variables) path. | :::danger + Keep in mind that included paths and the **Cache Push** step's workflow order are closely related to each other. For example, if you include a path from a repository and you place the **Cache Push** step before the **Git Clone** step, **Cache Push** won't find that path since it's not Git cloned yet. Although that's not a fatal error for **Cache Push**, it will inform you about unreachable paths on build logs. You can review and resolve those kinds of issues from build logs. + ::: :::caution + The other important prerequisite for this component to work is that it must be used after the step in which the generated artifact of the step is to be cached. For example, in the screen shot, to cache dependencies, the **Cache Push** step is used after the [**CocoaPods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) step. + ::: ### Input Variables -The parameters required for the operation of this step are given in the list below with their descriptions. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -56,18 +66,22 @@ The parameters required for the operation of this step are given in the list bel | `$AC_CACHE_LABEL` | User defined cache label to identify one cache from others. Both **Cache Push** and **Cache Pull** steps should have the same value to match. | Required | | `$AC_CACHE_INCLUDED_PATHS` | Specifies the files and folders that should be in the cache. Multiple glob patterns can be provided as a colon-separated list. For example; `.gradle:app/build` or `Pods:Podfile.lock`. | Required | | `$AC_CACHE_EXCLUDED_PATHS` | Specifies the files and folders that should be ignored from the cache. Multiple glob patterns can be provided as a colon-separated list. For example, `.gradle/*.lock:*.apk`. | Optional | -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository path. This path will be generated after running the [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/git-clone) step. | Optional | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository path. This path will be generated after running the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Optional | :::tip + **Cache Push** uses a pattern in order to select files and folders. Although the pattern is not a RegExp, it's closer to a shell glob. For example, `~/Library/Caches/CocoaPods` and `Pods` will select the `CocoaPods` folder from home and the repository direction as a whole. Or for an Android project, you can cache the `.gradle ` folder with `~/.gradle` include path and exclude all `.lock` files from there with `~/.gradle/**/*.lock` exclude path. Patterns that can be used in both included and excluded paths are explained in detail [here](https://github.com/appcircleio/appcircle-cache-push-component#included--excluded-paths). + ::: ### Output Variables -You cannot reach the cache archive file directly by yourself. But you can see cache file updates and track changes to cache at the end of the build pipeline from '[Download Artifacts](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) > `ac_cache.zip`'. Also, build logs have some useful information about the cache mechanism and how included and excluded paths are processed. You can see the produced cache file size from the build logs. (The size of the cache file affects upload and download durations.) +You cannot reach the cache archive file directly by yourself. But you can see cache file updates and track changes to cache at the end of the build pipeline from '[Download Artifacts](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) > `ac_cache.zip`'. Also, build logs have some useful information about the cache mechanism and how included and excluded paths are processed. You can see the produced cache file size from the build logs. (The size of the cache file affects upload and download durations.) :::caution -To view the generated artifacts on the [**Download Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts) step is included in the [workflow](/workflows) after this step. + +To view the generated artifacts on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in the [workflow](/workflows) after this step. + ::: --- diff --git a/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-build-profiles.md b/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-build-profiles.md index cc94aef69..58159bea1 100644 --- a/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-build-profiles.md +++ b/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-build-profiles.md @@ -12,21 +12,29 @@ import Screenshot from '@site/src/components/Screenshot'; With the build cache structure provided by Appcircle, cache files can be shared between different [**Build Profiles**](/build/manage-the-connections/adding-a-build-profile/). This sharing of files enables the faster generation of packages in different Build Profiles, reducing build time. Below is a simple, step-by-step example of how you can achieve this. :::info + This simple example will use our [**CocoaPods**](https://cocoapods.org/) files in different build profiles. If you intend to use a cache other than dependencies, please refer to the documentation for the [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) component. + ::: :::caution + To share cache between Build Profiles, the [**Cache Pull**](/workflows/common-workflow-steps/build-cache/cache-pull) component must be added to the related pipeline. + ::: :::caution + As an example, **master** and **development** branches were used, but you can apply the same operations to different branches. + ::: :::danger + Please note that the organizational structure of Appcircle is designed in such a way as to prevent any **security vulnerabilities**. Consequently, exchanging files between organizations or sub-organizations **is not permitted**. -You can find detailed information about the Appcircle organizational structure in the documentation [**here**](https://docs.appcircle.io/account/my-organization). +You can find detailed information about the Appcircle organizational structure in the documentation [**here**](/account/my-organization). + ::: 1. Firstly, the caching of CocoaPods files is initiated in the **`Appcircle Team`** build profile. These files will subsequently be utilized in the **`Appcircle Team 2`** build profile. To accomplish this, the [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) step should be incorporated into the workflow after the **CocoaPods Install** step in the initial build profile. @@ -50,5 +58,7 @@ You can find detailed information about the Appcircle organizational structure i :::danger + When sharing cache files between **Build Profiles**, please make sure that you spell your build profile ID and branch names correctly and use the [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) and [**Cache Pull**](/workflows/common-workflow-steps/build-cache/cache-pull) steps correctly in each profile.  + ::: \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-pipelines.md b/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-pipelines.md index b40dd3e87..a52ec8b34 100644 --- a/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-pipelines.md +++ b/docs/workflows/common-workflow-steps/build-cache/how-to-share-file-between-pipelines.md @@ -11,24 +11,32 @@ import Screenshot from '@site/src/components/Screenshot'; With the build cache structure provided by Appcircle, you can share cache files between pipelines in different branches. This sharing enables faster package generation across various branches, reducing overall build time. Below is a simple, step-by-step example of how you can achieve this. :::info + This simple example will use our [**CocoaPods**](https://cocoapods.org/) files in a different branch. If you want to use a cache other than dependencies, please refer to the documentation for the [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) component. + ::: :::info + As an example, **master** and **development** branches were used, but you can apply the same operations to different branches. + ::: :::danger + Please note that the organizational structure of Appcircle is designed in such a way as to prevent any **security vulnerabilities**. Consequently, exchanging files between organizations or sub-organizations **is not permitted**. -You can find detailed information about the Appcircle organizational structure in the documentation [**here**](https://docs.appcircle.io/account/my-organization). +You can find detailed information about the Appcircle organizational structure in the documentation [**here**](/account/my-organization). + ::: :::caution + In order to share cache between pipelines, the [**Cache Pull**](/workflows/common-workflow-steps/build-cache/cache-pull) component must be added to the related pipeline. + ::: -1. To start, cache the CocoaPods files in the **development** branch, which will later be utilized in the **master** branch. For this purpose, add the [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) step to the workflow after the [**CocoaPods Install**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/cocoapods-install) step. +1. To start, cache the CocoaPods files in the **development** branch, which will later be utilized in the **master** branch. For this purpose, add the [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) step to the workflow after the [**CocoaPods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) step. @@ -44,16 +52,20 @@ In order to share cache between pipelines, the [**Cache Pull**](/workflows/commo - :::caution - If you use more than one cache for the same branch, you can edit the [cache label](/workflows/common-workflow-steps/build-cache/cache-push#input-variables) accordingly in both [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) and [**Cache Pull**](/workflows/common-workflow-steps/build-cache/cache-pull) steps. For example: - - `$AC_BUILD_PROFILE_ID/development/cache-1` - - `$AC_BUILD_PROFILE_ID/development/cache-cocoapods` - ::: +:::caution + +If you use more than one cache for the same branch, you can edit the [cache label](/workflows/common-workflow-steps/build-cache/cache-push#input-variables) accordingly in both [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) and [**Cache Pull**](/workflows/common-workflow-steps/build-cache/cache-pull) steps. For example: +- `$AC_BUILD_PROFILE_ID/development/cache-1` +- `$AC_BUILD_PROFILE_ID/development/cache-cocoapods` + +::: 5. After this parameter change, the CocoaPods dependencies that were cached in the **development** branch pipeline will be automatically pulled to the **master** branch and used directly in the **master** branch pipeline. :::danger + When sharing cache files between pipelines, please make sure that you spell your branch names correctly and use the [**Cache Push**](/workflows/common-workflow-steps/build-cache/cache-push) and [**Cache Pull**](/workflows/common-workflow-steps/build-cache/cache-pull) steps correctly.  + ::: \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/build-cache/index.md b/docs/workflows/common-workflow-steps/build-cache/index.md index 219e49d02..81385cc10 100644 --- a/docs/workflows/common-workflow-steps/build-cache/index.md +++ b/docs/workflows/common-workflow-steps/build-cache/index.md @@ -10,16 +10,31 @@ import Screenshot from '@site/src/components/Screenshot'; Learn to streamline your workflows by pushing data to cache with our easy-to-follow cache-push tutorial. Ideal for improving build performance. + + Cache Push + # Cache Pull Discover the essentials of cache retrieval in our cache-pull guide. Speed up your build processes by mastering the art of efficiently pulling cached data. + + Cache Pull + + # How to Share Files Between Build Profiles Seamlessly share files between build profiles with our expert tips. This guide ensures consistent builds across profiles for better integration. + + How to Share Files Between Build Profiles + + # How to Share Files Between Pipelines -Facilitate file sharing between pipelines using our comprehensive strategies. Boost collaboration and pipeline efficiency with this crucial guide. \ No newline at end of file +Facilitate file sharing between pipelines using our comprehensive strategies. Boost collaboration and pipeline efficiency with this crucial guide. + + + How to Share Files Between Pipelines + \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/custom-script.md b/docs/workflows/common-workflow-steps/custom-script.md index 882f5887b..bceda0312 100644 --- a/docs/workflows/common-workflow-steps/custom-script.md +++ b/docs/workflows/common-workflow-steps/custom-script.md @@ -12,28 +12,52 @@ import Screenshot from '@site/src/components/Screenshot'; You can use **Custom Script** steps for additional functionalities in your builds. Appcircle will run the commands in your custom scripts and perform the specified actions. These scripts will be run on the runner and you can use any functionality of the build environment as you need. +### Prerequisites + +There are no prerequisites required before using the **Custom Script** step. + :::tip + Note that you can put the **Custom Script** component anywhere you want in the workflow. This step is used to add different capabilities to the existing workflow. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). +:::danger Sensitive Variables + +If you need to use sensitive variable in your script, please do not use these sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. + +::: + | Variable Name | Description | Status | | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | `Execute` | You can run your script as **`Bash`** or **`Ruby`** with two different language environments in the **Execute With** input value. | Required | | `Script` | With the **Script** input variable, you can add the script you want to run and run it directly in the selected language. If you leave this input blank, it will proceed to the next step without taking any action. | Optional | :::caution + Note that the **Script** area works according to the selected language variable. If you want to run a script in any language, make sure that you select the language correctly. + ::: -## Custom Script FAQ +--- + +To access the source code of this component, please use the following link: + +https://github.com/appcircleio/appcircle-custom-script-component + +--- + +## FAQ ### How to change Java version @@ -84,7 +108,7 @@ sed -i '' 's/old-value/new-value/g' build.gradle For each step in the workflow, you can view the input and output variables in the step configuration. -The repository directory is an output of the Git Clone step and its patch can be accessed with the `AC_REPOSITORY_PATH` environment variable by any step added after the Git Clone step. An example is as follows: +The repository directory is an output of the Git Clone step and its patch can be accessed with the `$AC_REPOSITORY_PATH` environment variable by any step added after the **Git Clone** step. An example is as follows: ```bash cd $AC_REPOSITORY_DIR @@ -93,7 +117,7 @@ cat README ### How to a add a file as a downloadable build artifact? -You can add any file to the output directory that contain the build artifacts using the `AC_OUTPUT_DIR` environment variable. An example is as follows: +You can add any file to the output directory that contain the build artifacts using the `$AC_OUTPUT_DIR` environment variable. An example is as follows: ```bash cd $AC_REPOSITORY_DIR/app/build/reports/ @@ -105,7 +129,9 @@ mv lint-results* $AC_OUTPUT_DIR/ This document provides a sample custom script written in Ruby that can be integrated into your CI/CD pipeline to enforce a minimum test coverage threshold. The script is designed to break the pipeline if the covered test result falls below a specified percentage. :::danger -Please note that this custom script must be placed after the [**Test Reports**](https://docs.appcircle.io/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) step in the workflow. + +Please note that this custom script must be placed after the [**Test Reports**](/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) step in the workflow. + ::: ```ruby @@ -156,10 +182,6 @@ Please feel free to edit the following variables according to your own requireme ::: -To access the source code of this component, please use the following link: - -https://github.com/appcircleio/appcircle-custom-script-component/ - ### How to use environment variables along with the `sudo` command? Both user-created and Appcircle-reserved [environment variables](/environment-variables/managing-variables) can be used within a custom script with any required command. But, by default, commands that are triggered with `sudo` will not reach them since the user scope is changed. diff --git a/docs/workflows/common-workflow-steps/danger.md b/docs/workflows/common-workflow-steps/danger.md index 05c9b45e6..1fc1919b2 100644 --- a/docs/workflows/common-workflow-steps/danger.md +++ b/docs/workflows/common-workflow-steps/danger.md @@ -1,7 +1,7 @@ --- title: Danger description: Streamline your code review process with Danger. Automate checks and enforce code standards pre-merge to maintain high-quality software. -tags: [code review, quality assurance, automaiton, development tools, appcircle, mobile ci/cd] +tags: [danger, code review, quality assurance, automaiton, development tools, appcircle, mobile ci/cd] --- @@ -19,17 +19,17 @@ https://appcircle.io/blog/danger-in-ci-automate-your-mobile-code-reviews :::danger -This tool does not support AzureDevOps. Therefore, if your repository is hosted on AzureDevOps, this tool will not function. Please use the [**Azure Bot for Swiftlint**](/workflows/ios-specific-workflow-steps/azure-bot-for-swiftlint)(for iOS) and [**Azure Bot for Detekt Report**](/workflows/android-specific-workflow-steps/azure-bot-for-detekt-report)(for Android) components instead. +This tool does not support AzureDevOps. Therefore, if your repository is hosted on AzureDevOps, this tool will not function. Please use the [**Azure Bot for Swiftlint**](/workflows/ios-specific-workflow-steps/azure-bot-for-swiftlint)(for iOS) and [**Azure Bot for Detekt Report**](/workflows/android-specific-workflow-steps/azure-bot-for-detekt-report)(for Android) components instead. ::: ### Prerequisites -The workflow steps that need to be executed before running the **Danger** step vary depending on the platform and are listed below: +Before running the **Danger** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | The repository needs to be cloned to begin the badge-adding process. After this step, the variable `AC_REPOSITORY_DIR` will be set. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repository needs to be cloned to begin the code review process. After this step, the variable `$AC_REPOSITORY_DIR` will be set. | :::caution @@ -41,13 +41,13 @@ Note that this component synchronizes with the [**Appcircle Triggers**](/build/b ### Input Variables -Below is a list of input variables that can be used with this component with a description of each. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Avoid hard-coding sensitive information like tokens and API keys directly into the step parameters. +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. @@ -55,8 +55,8 @@ We recommend using [**Environment Variables**](/environment-variables/managing-v | Variable Name | Description | Status | |-------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|----------| -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [Git Clone](/workflows/common-workflow-steps/git-clone) step. | Required | -| `$AC_DANGER_PATH` | Specifies path of Dangerfile. This path comes from `AC_REPOSITORY_DIR`. If DangerFile is in main directory of your repository. Do not change. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | +| `$AC_DANGER_PATH` | Specifies path of Dangerfile. This path comes from `$AC_REPOSITORY_DIR`. If DangerFile is in main directory of your repository. Do not change. | Required | | `$AC_DANGER_EXTRA_PARAMETERS` | Extra command line parameters. For Example: enter `--verbose` for verbose mode. | Optional | | `$DANGER_GITHUB_API_TOKEN` | Github Access Token for the bot user. | Optional | | `$DANGER_GITHUB_HOST` | The host that GitHub is running on. For example: `git.corp.com` | Optional | @@ -71,6 +71,7 @@ We recommend using [**Environment Variables**](/environment-variables/managing-v | `$DANGER_BITBUCKETSERVER_PASSWORD` | Bitbucket password for the bot user. | Optional | | `$DANGER_BITBUCKETSERVER_HOST` | The host that Bitbucket is running on. For example: `git.corp.com` | Optional | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/data-theorem-mobile-secure.md b/docs/workflows/common-workflow-steps/data-theorem-mobile-secure.md index e7c2950f9..1ffc879bc 100644 --- a/docs/workflows/common-workflow-steps/data-theorem-mobile-secure.md +++ b/docs/workflows/common-workflow-steps/data-theorem-mobile-secure.md @@ -12,7 +12,7 @@ The **Data Theorem Mobile Secure** step integrates the [Data Theorem Mobile Secu ### Prerequisites -The workflow steps that need to be executed before running the **Data Theorem Mobile Secure** step vary depending on the platform and are listed below: +Before running the **Data Theorem Mobile Secure** step, you must complete certain prerequisites, as detailed in the table below: #### For Android (Java / Kotlin and React Native) @@ -51,13 +51,15 @@ The workflow steps that need to be executed before running the **Data Theorem Mo ### Input Variables -Specific input variables are required for the operation of each component in your system. The following are the input variables necessary for the **Data Theorem Mobile Secure** step: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Confidential information should be entered as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, ensure that the [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [Configuration](/build/build-process-management/build-profile-configuration/). +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -67,10 +69,6 @@ Confidential information should be entered as a [secret environment variable](/e | `$AC_DT_UPLOAD_API_KEY` | Specifies the Data Theorem Mobile Secure Upload API Key. You need to obtain your organization's Upload API key from the portal. For more details, refer to [this document](https://docs.securetheorem.com/mobile_security_devops/uploading_mobile_apps.html). | Required | -### Output Variables - -The **Data Theorem Mobile Secure** step does not produce any output variables. The results are shown in the build log. - --- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/export-build-artifacts.md b/docs/workflows/common-workflow-steps/export-build-artifacts.md index f23ba7468..061e28bd8 100644 --- a/docs/workflows/common-workflow-steps/export-build-artifacts.md +++ b/docs/workflows/common-workflow-steps/export-build-artifacts.md @@ -12,19 +12,27 @@ import Screenshot from '@site/src/components/Screenshot'; Exports the specified build artifacts from the build agent to the Appcircle dashboard. The exported files will be available for download in the artifacts section of the completed build. :::danger + Sending applications to **Publish**, **Enterprise App Store**, or **Testing Distribution** will not work without this step. + ::: ### Prerequisites -:::info -We recommend using it as the last step in your workflow. +There are no prerequisites required before using the **Export Build Artifact** step. + +:::note + +We **recommend** using it as the **last** step in your workflow. + ::: :::danger + Remember, if you set a step to run after this step, artifacts generated after this step **will not be exported**. This step only exports the artifacts produced before it. + ::: ### Download Exported Artifacts @@ -43,7 +51,7 @@ If you use the **Default Workflow** templates, the option "**Always run this ste ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -53,6 +61,8 @@ You can find all the parameters required for this step in the table below, with | `$AC_UPLOAD_DIR` | If a folder path is specified, the files in this folder will be exported as artifacts. If a file path is specified, that file will be exported as an artifact. Uploading files with a 0 byte size in the specified path will be skipped. The default folder path is **`$AC_OUTPUT_DIR`**. | Required | | `$AC_DISABLE_UPLOAD_ON_FAIL` | The Delete Artifact for failed build variable is **false** by default. This variable allows you to export artifacts if a build succeeds, so that they do not take up disk space. | Optional | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-export-build-artifacts \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/fastlane.md b/docs/workflows/common-workflow-steps/fastlane.md index 04ad74b46..0a15811f9 100644 --- a/docs/workflows/common-workflow-steps/fastlane.md +++ b/docs/workflows/common-workflow-steps/fastlane.md @@ -14,37 +14,42 @@ With Appcircle, you can automate your build and signing processes with the flexi ### Prerequisites -The workflow steps that need to be executed before running the Fastlane workflow step, along with their respective reasons, are listed in the table below. +Before running the **Fastlane** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | The repo needs to be cloned in order to start the Fastlane process. After the clone, Fastlane will be installed. After this step works, the variable `AC_REPOSITORY_DIR` will be created. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repo needs to be cloned in order to start the Fastlane process. After the clone, Fastlane will be installed. After this step works, the variable `$AC_REPOSITORY_DIR` will be created. | :::caution + Fastlane needs project files to work. If there is no **Git Clone** step in your workflow, it will give an error because it cannot find the relevant files of the project. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_FASTLANE_DIR` | This path is Fastlane's path in the project. By default, it is AC_REPOSITORY_DIR. If your Fastlane file is in a different location in the repo, please change it. | Required | -| `$AC_FASTLANE_LANE` | Fastlane lane. For example: `android deploy` or `ios release` | Required | +| `$AC_FASTLANE_DIR` | This path is Fastlane's path in the project. By default, it is `$AC_REPOSITORY_DIR`. If your Fastlane file is in a different location in the repo, please change it. | Required | +| `$AC_FASTLANE_LANE` | Fastlane lane. For example: `android deploy` or `ios release`. | Required | +--- To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-fastlane-component +--- + -## Fastlane FAQ +## FAQ ### How to run a Fastlane plug-in directly? diff --git a/docs/workflows/common-workflow-steps/file-size-check.md b/docs/workflows/common-workflow-steps/file-size-check.md index 491a763ef..b529fb13b 100644 --- a/docs/workflows/common-workflow-steps/file-size-check.md +++ b/docs/workflows/common-workflow-steps/file-size-check.md @@ -14,13 +14,15 @@ The workflow steps that need to be executed before running the **File Size Check | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcodebuild for Devices**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/xcodebuild-for-ios-simulator) | If your project is an **iOS** project using **Objective-C/Swift** or **React Native**, you should use this step to generate the file before checking the app file size. This step generates the **IPA** file. | -| [**Flutter Build for iOS**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps/#flutter-build-for-ios) | If your project is an **iOS** project using **Flutter**, you should use this step to generate the file before checking the app file size. This step generates an **IPA** file. | -| [**Android Build**](https://docs.appcircle.io/workflows/android-specific-workflow-steps#android-build) | If your project is an **Android** project using **Java/Kotlin** or **React Native**, you should use this step to generate the file before checking the app file size. This step generates **APK** or **AAB** files. | -| [**Flutter Build for Android**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps/#flutter-build-for-android) | If your project is an **Android** project using **Flutter**, you should use this step to generate the file before checking the app file size. This step generates **APK** or **AAB** files. | +| [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) | If your project is an **iOS** project using **Objective-C/Swift** or **React Native**, you should use this step to generate the file before checking the app file size. This step generates the **IPA** file. | +| [**Flutter Build for iOS**](/workflows/flutter-specific-workflow-steps/flutter-build-for-ios) | If your project is an **iOS** project using **Flutter**, you should use this step to generate the file before checking the app file size. This step generates an **IPA** file. | +| [**Android Build**](/workflows/android-specific-workflow-steps/android-build) | If your project is an **Android** project using **Java/Kotlin** or **React Native**, you should use this step to generate the file before checking the app file size. This step generates **APK** or **AAB** files. | +| [**Flutter Build for Android**](/workflows/flutter-specific-workflow-steps/flutter-build-for-android) | If your project is an **Android** project using **Flutter**, you should use this step to generate the file before checking the app file size. This step generates **APK** or **AAB** files. | :::danger + If you use a different build step than the ones mentioned above to generate the app, then the **File Size Check** step depends on this particular step. + ::: #### For iOS @@ -30,6 +32,11 @@ If you use a different build step than the ones mentioned above to generate the ### Input Variables + +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). + +:::note + When you enter this component detail, you need to specify the **File Size** and **Check Action**. The file size parameter here represents the **maximum allowable** size of the **IPA**, **APK** or **AAB** file. If the archived application size exceeds this size, the pipeline will be **broken** or **warned** according to the **fail** or **warn** option you specify in the check action parameter. @@ -38,7 +45,7 @@ If you select **warn**, this is how it will appear in your build list: -You can find all the parameters required for this step in the table below, with their descriptions in detail. +::: | Variable Name | Description | Status | |----------------------------------|------------------------------------------------|--------------------------| @@ -47,9 +54,13 @@ You can find all the parameters required for this step in the table below, with | `$AC_ANALYZER_FILESIZE_ACTION` | Specifies whether to issue a warning or fail the workflow if the threshold limit is exceeded. The options are **warn** and **fail**, with the default being **fail**. | Optional | :::caution + Note that this step only controls the size of the application generated according to the size variable you specify. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-filesize-component \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/firebase-app-distribution.md b/docs/workflows/common-workflow-steps/firebase-app-distribution.md index 38454745e..5c5759989 100644 --- a/docs/workflows/common-workflow-steps/firebase-app-distribution.md +++ b/docs/workflows/common-workflow-steps/firebase-app-distribution.md @@ -17,15 +17,15 @@ Please note that you can also distribute your app via Appcircle. Utilizing Appci For more details, please refer to the following links: -- [Appcircle Testing Distribution](/testing-distribution/) -- [Appcircle Enterprise App Store](/enterprise-app-store/) -- [Appcircle Publish](/publish-module/) +- [**Appcircle Testing Distribution**](/testing-distribution/) +- [**Appcircle Enterprise App Store**](/enterprise-app-store/) +- [**Appcircle Publish**](/publish-module/) ::: ### Prerequisites -Below are the workflow steps required before running the **Firebase App Distribution** step, listed with their reasons. Prerequisites vary by platform: +Before running the **Firebase App Distribution** step, you must complete certain prerequisites, as detailed in the table below: #### For Android (Java / Kotlin and React Native) @@ -64,13 +64,15 @@ Below are the workflow steps required before running the **Firebase App Distribu ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for **Firebase App Distribution** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Confidential information should be entered as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, ensure that the [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [Configuration](/build/build-process-management/build-profile-configuration/). +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -86,10 +88,12 @@ Confidential information should be entered as a [secret environment variable](/e | `$AC_FIREBASE_GROUPS` | Specifies the Firebase tester groups you want to invite. | Optional | | `$AC_FIREBASE_EXTRA_PARAMETERS` | Specifies extra command line parameters. Enter `--debug` for debug mode. | Optional | -### Output Variables +:::info Output Variables The **Firebase App Distribution** step generates no output variables. The step succeeds if the app is distributed successfully; otherwise, it fails. +::: + --- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/fod-mobile-assesment.md b/docs/workflows/common-workflow-steps/fod-mobile-assesment.md index 367a66334..d80d10f2a 100644 --- a/docs/workflows/common-workflow-steps/fod-mobile-assesment.md +++ b/docs/workflows/common-workflow-steps/fod-mobile-assesment.md @@ -1,7 +1,7 @@ --- title: Fortify on Demand Mobile Assessment description: Optimize mobile app security with Fortify on Demand Mobile Assessment. Comprehensive testing for robust, secure mobile applications. -tags: [mobile, mobile ci/cd, security, integration, ios, android] +tags: [fortify, demand, mobile ci/cd, security, integration, ios, android] --- @@ -54,13 +54,13 @@ Before running the **Fortify on Demand Mobile Assessment** step, you must comple ### Input Variables -Below is a list of input variables that can be used with this component, along with a description of each. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Avoid hard-coding sensitive information, like tokens and API keys, directly into the step parameters. +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. @@ -78,6 +78,7 @@ We recommend using [**Environment Variables**](/environment-variables/managing-v | `$AC_FOD_PLATFORM_TYPE` | Platform type for this mobile assessment. | Required | | `$AC_FOD_FILE_PATH` | Full path of the `IPA` or `APK` file. | Required | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/ftp-upload.md b/docs/workflows/common-workflow-steps/ftp-upload.md index 4d1fe8ad3..3e29e6b5e 100644 --- a/docs/workflows/common-workflow-steps/ftp-upload.md +++ b/docs/workflows/common-workflow-steps/ftp-upload.md @@ -13,7 +13,9 @@ Appcircle's FTP Upload (File Transfer Protocol) integration lets you easily uplo ### Prerequisites -:::info +There are no prerequisites required before using the **FTP Upload** step. + +:::caution This step has no prerequisites but must follow the artifact production step. For example, as the screenshot below demonstrates, use it right after the [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) step. This setup ensures the IPA file produced in the pipeline is sent to any **FTP server**. @@ -31,13 +33,13 @@ Note that to send a file to an **FTP server**, the file must be generated within ### Input Variables -Below is a list of input variables that can be used with this component, with a description of each. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Avoid hard-coding sensitive information, like tokens and API keys directly into the step parameters. +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. @@ -51,7 +53,7 @@ We recommend using [**Environment Variables**](/environment-variables/managing-v | `$AC_FTP_SOURCE` | Source file or path to upload. For example: the file path can be set to `$AC_OUTPUT_DIR/Myapp.ipa`. Ensure that the file name is correct.| Required | | `$AC_FTP_TARGET` | The target path is on the FTP server. | Required | - +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/git-clone.md b/docs/workflows/common-workflow-steps/git-clone.md index e23da7dbb..39ace4cc3 100644 --- a/docs/workflows/common-workflow-steps/git-clone.md +++ b/docs/workflows/common-workflow-steps/git-clone.md @@ -8,41 +8,47 @@ import Screenshot from '@site/src/components/Screenshot'; # Git Clone -The **Git Clone** step is used to fetch the source code repository from a Git provider, such as [**GitHub**](https://docs.appcircle.io/build/adding-a-build-profile/connecting-to-github), [**GitLab**](https://docs.appcircle.io/build/adding-a-build-profile/connecting-to-gitlab), [**Bitbucket**](https://docs.appcircle.io/build/adding-a-build-profile/connecting-to-bitbucket), or [**Azure DevOps**](https://docs.appcircle.io/build/adding-a-build-profile/connecting-to-azure), and clone it into the runner where the build and deployment processes take place. This step ensures that the latest version of the codebase is available for subsequent build and deployment steps. +The **Git Clone** step is used to fetch the source code repository from a Git provider, such as [**GitHub**](/build/manage-the-connections/adding-a-build-profile/connecting-to-github), [**GitLab**](/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab), [**Bitbucket**](/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket), or [**Azure DevOps**](/build/manage-the-connections/adding-a-build-profile/connecting-to-azure), and clone it into the runner where the build and deployment processes take place. This step ensures that the latest version of the codebase is available for subsequent build and deployment steps. ### Prerequisites -Below is a list of workflow steps that must be completed before executing the **Git Clone** workflow step, along with their respective descriptions: +Before running the **Git Clone** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Activate SSH Private Key**](https://docs.appcircle.io/workflows/common-workflow-steps/#activate-ssh-key) | This step sets up your SSH key on the build machine **if you used one to connect your repository with SSH**. | +| [**Activate SSH Private Key**](/workflows/common-workflow-steps/active-ssh-private-key) | This step sets up your SSH key on the build machine **if you used one to connect your repository with SSH**. | :::caution + If you have not connected your repo via SSH, the **Git Clone** does not have any dependency on the **Activate SSH Private Key** step. + ::: :::info + We recommend using this step at the beginning of the workflow to avoid any problems in the workflow. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). :::danger -After connecting the repository, the following [**Reserved Environment Variables**](https://docs.appcircle.io/environment-variables/appcircle-specific-environment-variables), which **Git Clone** uses as input, will be automatically populated. Ensure that the variable you provide has a value if you intend to make any changes. **The required variables must not be left empty**. + +After connecting the repository, the following [**Reserved Environment Variables**](/environment-variables/appcircle-specific-environment-variables), which **Git Clone** uses as input, will be automatically populated. Ensure that the variable you provide has a value if you intend to make any changes. **The required variables must not be left empty**. + ::: | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_GIT_URL` | URL of the repository. After the [**provider connection**](https://docs.appcircle.io/build/adding-a-build-profile/) is completed with the Git provider, these values will be set automatically. | Required | +| `$AC_GIT_URL` | URL of the repository. After the [**provider connection**](/build/manage-the-connections/adding-a-build-profile) is completed with the Git provider, these values will be set automatically. | Required | | `$AC_GIT_COMMIT` | Commit of the repository. This value will come from the Git provider. When a new commit is pushed, Appcircle fetches the details of the latest commit. | Optional | -| `$AC_GIT_BRANCH` | Branch of the repository. You can find more details about [**branch management**](https://docs.appcircle.io/build/build-profile-branch-operations). The branch information selected before starting manual build on the interface is automatically included here. | Optional | +| `$AC_GIT_BRANCH` | Branch of the repository. You can find more details about [**branch management**](/build/build-process-management/build-profile-branch-operations). The branch information selected before starting manual build on the interface is automatically included here. | Optional | | `$AC_GIT_TAG` | Tag of the repository. If you have tags in your repository, Appcircle can start a build according to the tags. | Optional | | `$AC_GIT_LFS` | Used to specify whether large files will be downloaded. The default value is `false`. | Optional | | `$AC_GIT_SUBMODULE` | Used to specify whether the submodule should be cloned. | Optional | @@ -51,9 +57,13 @@ After connecting the repository, the following [**Reserved Environment Variables ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |-------------------------------|------------------------------------------------| -| `$AC_REPOSITORY_DIR` | Specifies the root directory of the cloned repository. This path is automatically generated after the repository is cloned. | +| `AC_REPOSITORY_DIR` | Specifies the root directory of the cloned repository. This path is automatically generated after the repository is cloned. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/jira-comment.md b/docs/workflows/common-workflow-steps/jira-comment.md index f2a893d81..a7aef7660 100644 --- a/docs/workflows/common-workflow-steps/jira-comment.md +++ b/docs/workflows/common-workflow-steps/jira-comment.md @@ -16,7 +16,7 @@ By adding Appcircle's [**Jira Comment**](https://github.com/appcircleio/appcircl ## Prerequisites -There is no mandatory sequence for the use of this component. It depends on your business decision which step to use before or after in your workflow. +There are no prerequisites required before using the **Jira Comment** step. :::caution @@ -66,13 +66,15 @@ If you're utilizing [API version 2](https://developer.atlassian.com/cloud/jira/p ## Input Variables -There are some necessary parameters for this stepper to work properly. These parameters are given in the table below with their descriptions. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. -Confidential information should be entered as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, ensure that the [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [configuration](/build/build-process-management/build-profile-configuration/). +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -98,7 +100,7 @@ The required inputs for authorization vary based on the type of Jira instance (O | `$AC_JIRA_EMAIL` | The email associated with your Jira account. This field is required for using API tokens instead of PAT. | Optional | | `$AC_JIRA_TOKEN` | User's API Token. If this value is fill, the Jira e-mail field must be filled. Only Jira Cloud users can use API Token. You can create token from [here](https://id.atlassian.com/manage-profile/security/api-tokens) | Optional | | `$AC_JIRA_PAT` | Specify the Personal Access Token for Jira authentication. Only Jira On-Prem users can use PAT. | Optional | -| `$AC_JIRA_ISSUE` | The ID or key of the issue. Refer to the [documentation](/workflows/common-workflow-steps/jira-comment#configuration-of-jira-comment) for instructions on extracting this information from branch names or commit messages. | Required | +| `$AC_JIRA_ISSUE` | The ID or key of the issue. Refer to this [header](/workflows/common-workflow-steps/jira-comment#configuration-of-jira-comment) for instructions on extracting this information from branch names or commit messages. | Required | | `$AC_JIRA_FAIL_TRANSITION` | Transition ID or name for the failed step. Optionally change the status of your issue if the previous state fails. Ensure that the `Always run this step even if the previous steps fail` switch is enabled for this feature to work. | Optional | | `$AC_JIRA_SUCCESS_TRANSITION` | Transition ID or name for the successful step. Optionally change the status of your issue if the previous state succeeds. | Optional | | `$AC_JIRA_TEMPLATE_V2` | The comment template used to post a comment if [Jira REST API Version 2](#jira-rest-api-version-reference) is selected. Variables prefixed with `$` will be replaced during the build process. Refer to [this header](#changing-template) to modify the template. | Required | diff --git a/docs/workflows/common-workflow-steps/maestro-cloud-upload.md b/docs/workflows/common-workflow-steps/maestro-cloud-upload.md index c4a2d7c09..f4ace693c 100644 --- a/docs/workflows/common-workflow-steps/maestro-cloud-upload.md +++ b/docs/workflows/common-workflow-steps/maestro-cloud-upload.md @@ -14,7 +14,7 @@ The Appcircle **Maestro Cloud Upload** step enables users to upload their mobile ## Prerequisites -Before running the **Maestro Cloud Upload** step, certain prerequisites must be completed. These prerequisites, detailed in the table below, vary depending on the platform: +Before running the **Maestro Cloud Upload** step, you must complete certain prerequisites, as detailed in the table below: ### For All Platforms @@ -59,13 +59,15 @@ Before running the **Maestro Cloud Upload** step, certain prerequisites must be ## Input Variables -The **Maestro Cloud Upload** step requires specific input variables: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Enter confidential information as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, select the appropriate [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) in the [Configuration](/build/build-process-management/build-profile-configuration/). +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -89,9 +91,11 @@ Enter confidential information as a [secret environment variable](/environment-v | `$AC_MAESTRO_PULL_ID` | The ID of the pull request from which the upload originated. | Optional | | `$AC_MAESTRO_CLI_VERSION` | The version of the Maestro CLI is to be downloaded in your CI environment. The default value is the `latest` version. | Optional | -## Output Variables +:::info Output Variables + +The **Maestro Cloud Upload** step generates no output variables. The results are shown in the build log. -The **Maestro Cloud Upload** step does not produce any output variables. The results are shown in the build log. +::: --- diff --git a/docs/workflows/common-workflow-steps/marathon-cloud.md b/docs/workflows/common-workflow-steps/marathon-cloud.md index 1d8a8bda2..40b0c39bf 100644 --- a/docs/workflows/common-workflow-steps/marathon-cloud.md +++ b/docs/workflows/common-workflow-steps/marathon-cloud.md @@ -15,21 +15,25 @@ The **Marathon Cloud** component is an integrated test automation workflow step ### Prerequisites -This component needs some prerequisites for proper operation; the necessary steps are given in the table below with details. +Before running the **Marathon Cloud** step, you must complete certain prerequisites, as detailed in the table below: :::caution + Please note that this component works separately on both the native **Android** and **iOS** platforms. The requirements for both platforms are different. + ::: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcodebuild for Testing**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/xcodebuild-for-testing) | After the Xcodebuild for Testing step runs, the test IPA paths `$AC_TEST_IPA_PATH` and `$AC_UITESTS_RUNNER_PATH` will be created automatically. So that the **Marathon Cloud** component depends on these paths. | -| [**Android Build for UI Testing**](https://docs.appcircle.io/workflows/android-specific-workflow-steps/android-build-for-ui-testing) | Once the Android Build for UI Testing step is completed, the test APK paths `$AC_APK_PATH` and `$AC_TEST_APK_PATH` are automatically generated. The **Marathon Cloud** component relies on these paths. | +| [**Xcodebuild for Testing**](/workflows/ios-specific-workflow-steps/xcodebuild-for-testing) | After the Xcodebuild for Testing step runs, the test IPA paths `$AC_TEST_IPA_PATH` and `$AC_UITESTS_RUNNER_PATH` will be created automatically. So that the **Marathon Cloud** component depends on these paths. | +| [**Android Build for UI Testing**](/workflows/android-specific-workflow-steps/android-build-for-ui-testing) | Once the Android Build for UI Testing step is completed, the test APK paths `$AC_APK_PATH` and `$AC_TEST_APK_PATH` are automatically generated. The **Marathon Cloud** component relies on these paths. | :::danger + When using this component for the **iOS platform**, do not forget to change the **`Destination`** value in the **Xcodebuild for Testing** step. This value will be `generic/platform=iOS` by default. This means that it creates a generic test `IPA` for all iOS devices. Since the Marathon Cloud component runs on a specific test device, you need to change this value. For example, `platform=iOS Simulator,name=iPhone 15 Pro,OS=17.2`. -Please note that if you do not change this parameter, the Marathon Cloud component will fail and the pipeline will break. For further information, please follow the [**Xcodebuild for Testing documentation**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/xcodebuild-for-testing). +Please note that if you do not change this parameter, the Marathon Cloud component will fail and the pipeline will break. For further information, please follow the [**Xcodebuild for Testing documentation**](/workflows/ios-specific-workflow-steps/xcodebuild-for-testing). + ::: #### For Android @@ -43,24 +47,28 @@ Please note that if you do not change this parameter, the Marathon Cloud compone ### Input Variables -The parameters required for the operation of this component are given below with explanations.  +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger -**Avoid hard-coding sensitive variables, such as tokens or API keys, directly into the parameters of the step.** +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. -We recommend using [**Environment Variables**](https://docs.appcircle.io/environment-variables/) groups for such sensitive variables. ::: | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| | `$AC_MARATHON_API_KEY` | Marathon Cloud API key. To get an API key, please follow the Marathon Cloud [**documentation**](https://docs.marathonlabs.io/?_gl=1*fsz3tj*_ga*MTYyMzE3NDMwOC4xNzA2Njk3MzA5*_ga_7RE7PPY2QW*MTcxMTAwMzEyNC4yNS4xLjE3MTEwMDU5ODYuMjQuMC4w*_gcl_au*MjA1NTI4NzUyNC4xNzA2Njk3MzUw#api-key). | Required | | `$AC_MARATHON_TEST_NAME` | This name will be shown on the Marathon Cloud dashboard test run list. | Required | -| `$AC_MARATHON_APP_PATH` | Specify the path to the application binary. This application is generated by the corresponding testing step (**Android Build for UI Testing** or **Xcodebuild for Testing**). The default value is `AC_APK_PATH ` for Android or `AC_TEST_IPA_PATH` for iOS. | Required | -| `$AC_MARATHON_UITEST_RUNNER_APP_PATH` | Specifies the path to the test application binary. This application is generated by the corresponding testing step (**Android Build for UI Testing** or **Xcodebuild for Testing**). The default value is `AC_TEST_APK_PATH ` for Android or `AC_UITESTS_RUNNER_PATH` for iOS. | Required | +| `$AC_MARATHON_APP_PATH` | Specify the path to the application binary. This application is generated by the corresponding testing step (**Android Build for UI Testing** or **Xcodebuild for Testing**). The default value is `$AC_APK_PATH ` for Android or `$AC_TEST_IPA_PATH` for iOS. | Required | +| `$AC_MARATHON_UITEST_RUNNER_APP_PATH` | Specifies the path to the test application binary. This application is generated by the corresponding testing step (**Android Build for UI Testing** or **Xcodebuild for Testing**). The default value is `$AC_TEST_APK_PATH ` for Android or `$AC_UITESTS_RUNNER_PATH` for iOS. | Required | | `$AC_OUTPUT_DIR` | Specifies the path for Marathon Cloud outputs. This path will be automatically defined. Do not change if it is not necessary. | Required | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-marathonlabs-component \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/publish-release-notes.md b/docs/workflows/common-workflow-steps/publish-release-notes.md index ba60dff90..60228e6a8 100644 --- a/docs/workflows/common-workflow-steps/publish-release-notes.md +++ b/docs/workflows/common-workflow-steps/publish-release-notes.md @@ -34,20 +34,18 @@ To create rich release notes, the Release Notes component should be included in ### Input Variables -You can find all the parameters required for this step in the table below, along with detailed descriptions. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_RELEASE_NOTES_PATH` | Specifies the path of the release notes. You can override the `AC_RELEASE_NOTES_PATH` environment variable or provide its full path, e.g., `./release-notes.txt`. If the path is empty, release notes will be auto-generated. | Optional | +| `$AC_RELEASE_NOTES_PATH` | Specifies the path of the release notes. You can override the `$AC_RELEASE_NOTES_PATH` environment variable or provide its full path, e.g., `./release-notes.txt`. If the path is empty, release notes will be auto-generated. | Optional | | `$AC_RELEASE_NOTES_TEMPLATE` | This variable is an ERB template. You can enrich the contents of your release notes with environment variables or Ruby snippets. | Optional | ### Output Variables -| Variable Name | Description | -| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| ` ` | This step creates the `release-notes.txt` file. It does not keep this file in a variable, but you can access this file via [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts). | +This step creates the `release-notes.txt` file. It does not keep this file in a variable, but you can access this file via [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts). @@ -61,4 +59,4 @@ Don't forget to use the [**Export Build Artifacts**](/workflows/common-workflow- To access the source code of this component, please use the following link: -https://github.com/appcircleio/appcircle-flutter-web-build-component +https://github.com/appcircleio/appcircle-release-notes-component diff --git a/docs/workflows/common-workflow-steps/repeato-test-runner.md b/docs/workflows/common-workflow-steps/repeato-test-runner.md index f9331d2be..1197aa1f5 100644 --- a/docs/workflows/common-workflow-steps/repeato-test-runner.md +++ b/docs/workflows/common-workflow-steps/repeato-test-runner.md @@ -18,18 +18,20 @@ https://appcircle.io/blog/streamline-project-integration-and-test-automation-wit ### Prerequisites -Before executing the **Repeato Test Runner** workflow step, certain prerequisite workflow steps must be completed: +Before running the **Repeato Test Runner** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**Git Clone**](/workflows/common-workflow-steps/#git-clone) | The repository that needs to be built must be fetched from the branch. Upon completion of the **Git Clone** step, it generates the `AC_REPOSITORY_DIR` variable, which is then used as the input for the Android Build step. | +| [**Git Clone**](/workflows/common-workflow-steps/#git-clone) | The repository that needs to be built must be fetched from the branch. Upon completion of the **Git Clone** step, it generates the `$AC_REPOSITORY_DIR` variable, which is then used as the input for the Android Build step. | :::danger + If you wish to view the test results on Appcircle's Test Reports page, it is essential to use the [Test Reports](https://github.com/appcircleio/appcircle-test-report-component) step after the **Repeato Test Runner**. Please check out this document for more information: [Generating Test Report](/continuous-testing/android-testing/running-android-unit-tests#generating-test-report) + ::: ### Input Variables @@ -38,9 +40,11 @@ Specific input variables are required for the **Repeato Test Runner** to functio -:::danger +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. -Confidential information must be entered as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Additionally, ensure that the appropriate [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [Configuration](/build/build-process-management/build-profile-configuration/). +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -54,13 +58,13 @@ Confidential information must be entered as a [secret environment variable](/env ### Output Variables -The outputs resulting from the operation of this component are as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | -------------------------- | -------------------------------------------------------- | -| `$AC_REPEATO_REPORT` | Report of Repeato batches that have been executed. | -| `$AC_REPEATO_JUNIT_REPORT` | Report of Repeato executed tests in JUnit XML format. | -| `$AC_TEST_RESULT_PATH` | The directory where your JUnit XML report will be saved. | +| `AC_REPEATO_REPORT` | Report of Repeato batches that have been executed. | +| `AC_REPEATO_JUNIT_REPORT` | Report of Repeato executed tests in JUnit XML format. | +| `AC_TEST_RESULT_PATH` | The directory where your JUnit XML report will be saved. | --- diff --git a/docs/workflows/common-workflow-steps/set-environment-variable.md b/docs/workflows/common-workflow-steps/set-environment-variable.md index 74cd3a519..d26c4f511 100644 --- a/docs/workflows/common-workflow-steps/set-environment-variable.md +++ b/docs/workflows/common-workflow-steps/set-environment-variable.md @@ -1,7 +1,7 @@ --- title: Set Environment Variable description: Set Environment Variable step sets environment value for given keys -tags: [environment, variable] +tags: [set, environment, variable] --- import Screenshot from '@site/src/components/Screenshot'; @@ -11,7 +11,7 @@ import Screenshot from '@site/src/components/Screenshot'; The **Set Environment Variable** step enables the setting of environment values for specified keys. Although creating environment variables via the [Environment Variables](/environment-variables/) page is typically recommended, this step provides flexibility to modify environment variables directly within the build workflow when necessary. ### Prerequisites -There is no prerequisites step before the **Set Environment Variable** step. It can be implemented at any point within the workflow as necessary. +There are no prerequisites required before using the **Set Environment Variable** step. It can be implemented at any point within the workflow as necessary. :::danger @@ -23,12 +23,15 @@ Please note that you must use the **Set Environment Variable** step before the s ### Input Variables -Each component requires specific input variables for operation. For the **Set Environment Variable** step, the necessary input variables are: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). + -:::danger +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. -Confidential information should be entered as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, ensure that the [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [Configuration](/build/build-process-management/build-profile-configuration/). +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -37,10 +40,12 @@ Confidential information should be entered as a [secret environment variable](/e | `$AC_SETENV_KEYS` | Specifies the key of the environment variable to be set. This should be a space-separated list of environment variable keys. | Required | | `$AC_SETENV_VALUE` | Specifies the value of the environment variable to set. If this field is left blank, the environment variable will be set to `null`. | Optional | -### Output Variables +:::info Output Variables The **Set Environment Variable** step generates no output variables. Success or failure of this step depends on whether the environment variable is set correctly, allowing subsequent use within the workflow. +::: + --- To access the source code of this component, please use the following link: diff --git a/docs/workflows/common-workflow-steps/snyk-scan-security.md b/docs/workflows/common-workflow-steps/snyk-scan-security.md index ad6ccceb0..009079ee6 100644 --- a/docs/workflows/common-workflow-steps/snyk-scan-security.md +++ b/docs/workflows/common-workflow-steps/snyk-scan-security.md @@ -14,7 +14,7 @@ The **Snyk Security Scan** step integrates directly into Appcircle’s CI/CD wor ### Prerequisites -Before running the **Snyk Scan Security** step, certain prerequisites must be completed. These prerequisites, detailed in the table below: +Before running the **Snyk Scan Security** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | -------------------------- | --------------------------------------------------------------------------------------------- | @@ -24,13 +24,15 @@ Before running the **Snyk Scan Security** step, certain prerequisites must be co ### Input Variables -Each component requires specific input variables for its operation. The input variables necessary for the **Snyk Scan Security** step are: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Enter confidential information as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, select the appropriate [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) in the [Configuration](/build/build-process-management/build-profile-configuration/). +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -49,12 +51,12 @@ Enter confidential information as a [secret environment variable](/environment-v ### Output Variables -The outputs resulting from the operation of this component are as follows: +The output(s) resulting from the operation of this component are as follows: | Output Variable | Description | |--------------------------------|--------------------------------------------------------------------------------------------------------------------------| -| `$AC_SNYK_REPORT` | The [Snyk report](https://docs.snyk.io/manage-risk/reporting/) file containing the results of executed tests. | -| `$AC_SNYK_MONITOR_EXPLORE_LINK`| The [link to explore and monitor](https://docs.snyk.io/snyk-cli/commands/monitor) the project's security status on Snyk. | +| `AC_SNYK_REPORT` | The [Snyk report](https://docs.snyk.io/manage-risk/reporting/) file containing the results of executed tests. | +| `AC_SNYK_MONITOR_EXPLORE_LINK`| The [link to explore and monitor](https://docs.snyk.io/snyk-cli/commands/monitor) the project's security status on Snyk. | --- diff --git a/docs/workflows/common-workflow-steps/sonarqube.md b/docs/workflows/common-workflow-steps/sonarqube.md index f55ca5e87..22b48fe0f 100644 --- a/docs/workflows/common-workflow-steps/sonarqube.md +++ b/docs/workflows/common-workflow-steps/sonarqube.md @@ -14,19 +14,22 @@ This step allows you to analyse your code quality with the [SonarQube CLI](https ### Prerequisites -The workflow steps that need to be executed before running the **SonarQube** workflow step, along with their respective reasons, are listed in the table below. +Before running the **SonarQube** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | If you intend to retrieve the **SonarQube Scanner** parameters from the `sonar-project.properties` file in your repository, it's essential to employ the **Git Clone** step before the **SonarQube** step. After the **Git Clone** step is completed, it generates the `AC_REPOSITORY_DIR` variable, which is used as input for the **SonarQube** step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | If you intend to retrieve the **SonarQube Scanner** parameters from the `sonar-project.properties` file in your repository, it's essential to employ the **Git Clone** step before the **SonarQube** step. After the **Git Clone** step is completed, it generates the `$AC_REPOSITORY_DIR` variable, which is used as input for the **SonarQube** step. | ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. + +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). :::caution -Please note that **SonarQube** is a commercial code quality analysis tool. The parameters required for the scanner to work should be used as [**Enviroment Variables**](https://docs.appcircle.io/environment-variables/) as they may create security vulnerabilities. You can obtain these parameters by contacting your DevOps team. + +Please note that **SonarQube** is a commercial code quality analysis tool. The parameters required for the scanner to work should be used as [**Enviroment Variables**](/environment-variables) as they may create security vulnerabilities. You can obtain these parameters by contacting your DevOps team. + ::: | Variable Name | Description |Status      | @@ -36,28 +39,39 @@ Please note that **SonarQube** is a commercial code quality analysis tool. The p | `$AC_SONAR_EXTRA_PARAMETERS` | Extra command line parameters. Enter `-X` for debug mode. | Optional | ### Including Tests + You can also include your unit/UI test results in the **SonarQube** analysis. :::caution + If you want to include your test results in the **SonarQube** analysis, always run the **SonarQube** step after the test step. + ::: #### iOS Tests + :::danger -SonarQube accepts `XML` format files to analyse test results. In order to analyse your test results, do not forget to convert the test results to `XML` format by running the [**Convert Xcresult to HTML/XML**](https://github.com/appcircleio/appcircle-ios-xcresult-convert-html-xml-component) step after the [**Xcodebuild for Unit and UI testing**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-unit-and-ui-tests) step. + +SonarQube accepts `XML` format files to analyse test results. In order to analyse your test results, do not forget to convert the test results to `XML` format by running the [**Convert Xcresult to HTML/XML**](/workflows/ios-specific-workflow-steps/convert-xcresult-to-xml-html) step after the [**Xcodebuild for Unit and UI testing**](/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test) step. + ::: #### Android Tests + If you intend to send the test result file obtained from the Android unit test output to **SonarQube**, it is necessary to execute the **Android Unit Tests** step before the **SonarQube** step. :::caution -Ensure that the test result path provided to **SonarQube** as a property matches the test result path generated by the [**Android Unit Tests**](https://docs.appcircle.io/workflows/android-specific-workflow-steps/#android-unit-tests) step, and direct the output to that location. + +Ensure that the test result path provided to **SonarQube** as a property matches the test result path generated by the [**Android Unit Tests**](/workflows/android-specific-workflow-steps/android-unit-tests) step, and direct the output to that location. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-sonarqube-component \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/testinium.md b/docs/workflows/common-workflow-steps/testinium.md index 77b2e404c..e86c90a13 100644 --- a/docs/workflows/common-workflow-steps/testinium.md +++ b/docs/workflows/common-workflow-steps/testinium.md @@ -12,7 +12,7 @@ The **Testinium** step integrates the [Testinium](https://testinium.com/) testin ### Prerequisites -Before running the **Testinium** step, certain prerequisites must be completed. These prerequisites, detailed in the table below, vary depending on the platform: +Before running the **Testinium** step, you must complete certain prerequisites, as detailed in the table below: #### For Android (Java / Kotlin and React Native) @@ -51,13 +51,15 @@ Before running the **Testinium** step, certain prerequisites must be completed. ### Input Variables -For each component, specific input variables are required for its operation on your system. The input variables necessary for **Testinium** are as follows: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Confidential information should be entered as a [secret environment variable](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs). Also, ensure that the [environment variable group](/environment-variables/managing-variables#using-environment-variable-groups-in-builds) is selected in the [Configuration](/build/build-process-management/build-profile-configuration/). +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. ::: @@ -75,15 +77,15 @@ Confidential information should be entered as a [secret environment variable](/e ### Output Variables -Below are the output variables generated by this component: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | -------------------------------------- | ------------------------------------------------------- | -| `$AC_TESTINIUM_RESULT_FAILURE_SUMMARY` | Total number of failures in the test. | -| `$AC_TESTINIUM_RESULT_ERROR_SUMMARY` | Total number of errors in the test. | -| `$AC_TESTINIUM_RESULT_SUCCESS_SUMMARY` | Total number of successes in the test results. | +| `AC_TESTINIUM_RESULT_FAILURE_SUMMARY` | Total number of failures in the test. | +| `AC_TESTINIUM_RESULT_ERROR_SUMMARY` | Total number of errors in the test. | +| `AC_TESTINIUM_RESULT_SUCCESS_SUMMARY` | Total number of successes in the test results. | --- diff --git a/docs/workflows/common-workflow-steps/upload-files-to-amazon-s3.md b/docs/workflows/common-workflow-steps/upload-files-to-amazon-s3.md index 732de0d20..54aafe03a 100644 --- a/docs/workflows/common-workflow-steps/upload-files-to-amazon-s3.md +++ b/docs/workflows/common-workflow-steps/upload-files-to-amazon-s3.md @@ -16,15 +16,19 @@ The **Upload Files to Amazon S3** step in Appcircle enables direct uploading of There are no prerequisites required before using the **Upload Files to Amazon S3** step. +:::info + To begin, add the **Upload Files to Amazon S3** step to the workflow from the [workflow marketplace](/workflows/#workflow-marketplace). You can incorporate it at any point within the workflow and multiple times, as necessary, to upload specific files or folders. For example, you can place it after the build step to deploy the build outputs. Once added, exit the workflow edit mode by saving your changes, and then click on the **Upload Files to Amazon S3** step. +::: + ### Input Variables -Below is a table containing all the parameters required for the **Upload Files to Amazon S3** step, along with detailed descriptions: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -39,17 +43,17 @@ Below is a table containing all the parameters required for the **Upload Files t :::info -It is highly recommended to add the keys as [secret environment variables](../../.././environment-variables/managing-variables) instead of typing them here for security purposes. +It is highly recommended to add the keys as [secret environment variables](/environment-variables/managing-variables) instead of typing them here for security purposes. ::: ### Output Variables -As the output may vary depending on the task you execute, there is no specific output defined by default. +The output(s) resulting from the operation of this component are as follows: | Output Variable | Description | |-------------------------|----------------------------------------------------------------| -| `$AC_AWS_UPLOAD_URL` | Specifies that the files and folders are deployed to a newly created directory as `s3://bucket-name/timestamp` to avoid any conflicts and potential overwrites. | +| `AC_AWS_UPLOAD_URL` | Specifies that the files and folders are deployed to a newly created directory as `s3://bucket-name/timestamp` to avoid any conflicts and potential overwrites. | After saving your settings, the build can be run, and the step will be executed accordingly. Details of the upload operation can be viewed in the build logs: diff --git a/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md b/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md index 9309f2b05..9c168f006 100644 --- a/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md +++ b/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md @@ -1,7 +1,7 @@ --- title: Firebase Deployment description: Firebase deployment is quick, and secure app launches. Get started with our concise guide to deploying on Firebase efficiently. -tags: [firebase, mobile, web, distribution] +tags: [firebase, web, distribution, deployment, web applications] --- import Screenshot from '@site/src/components/Screenshot'; @@ -14,7 +14,7 @@ Deploy web applications effortlessly using Appcircle's Firebase Deployment compo ### Prerequisites -Before running the **Firebase Deployment** step, certain prerequisites must be completed. These prerequisites are detailed in the table below: +Before running the **Firebase Deployment** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| @@ -25,13 +25,13 @@ Before running the **Firebase Deployment** step, certain prerequisites must be c ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Avoid hard-coding sensitive information like tokens and API keys directly into the step parameters. +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. @@ -45,6 +45,7 @@ We recommend using [**Environment Variables**](/environment-variables/managing-v | `$GOOGLE_APPLICATION_CREDENTIALS` | Specify the path to your Google Service Account JSON file. Upload this file to your environment group under the name `GOOGLE_APPLICATION_CREDENTIALS`. Choose either a **Firebase token** or a **Google Service account**. | Optional | | `$AC_FIREBASE_EXTRA_PARAMETERS` | Extra command line parameters. Enter --debug for debug mode. | Optional | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/flutter-specific-workflow-steps/flutter-analyze.md b/docs/workflows/flutter-specific-workflow-steps/flutter-analyze.md index 2677b6962..af973dfaa 100644 --- a/docs/workflows/flutter-specific-workflow-steps/flutter-analyze.md +++ b/docs/workflows/flutter-specific-workflow-steps/flutter-analyze.md @@ -1,7 +1,7 @@ --- title: Flutter Analyze description: This component runs the `flutter analyze` command in your Flutter project. -tags: [flutter, build, test, workflow, step] +tags: [flutter, analyze, build, test, workflow, step] --- import Screenshot from '@site/src/components/Screenshot'; @@ -11,28 +11,35 @@ import Screenshot from '@site/src/components/Screenshot'; This component runs the `flutter analyze` command in your Flutter project. Please note that it requires the [**Flutter SDK**](https://docs.flutter.dev/get-started/install). ### Prerequisites + +Before running the **Flutter Analyze** step, you must complete certain prerequisites, as detailed in the table below: + | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | This step will clone your project through the connected Git provider and create the `$AC_REPOSITORY_DIR` variable. | -| [**Flutter Install**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-install) | This step will install the [Flutter SDK](https://flutter-ko.dev/development/tools/sdk/releases) release. If the version is not specified, it will install the latest **stable** version. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step will clone your project through the connected Git provider and create the `$AC_REPOSITORY_DIR` variable. | +| [**Flutter Install**](/workflows/flutter-specific-workflow-steps/flutter-install) | This step will install the [Flutter SDK](https://flutter-ko.dev/development/tools/sdk/releases) release. If the version is not specified, it will install the latest **stable** version.| :::danger + This step is particularly dependent on the Flutter Install step. If the Flutter SDK is not installed, the step will give an error that the required command was not found. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_FLUTTER_PROJECT_DIR` | This parameter is used as the repository path. This path is created immediately after the Git Clone step. If the Git Clone step is not used, this path cannot be found. | Required| +| `$AC_FLUTTER_PROJECT_DIR` | This parameter is used as the repository path. This path is created immediately after the **Git Clone** step. If the **Git Clone** step is not used, this path cannot be found. | Required | | `$AC_FLUTTER_ANALYZE_EXTRA_ARGS` | You can use this parameter if you want to add an extra parameter to the build command line. | Optional | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-flutter-analyze-component diff --git a/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-android.md b/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-android.md index dca5cb4a1..fb560d785 100644 --- a/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-android.md +++ b/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-android.md @@ -12,17 +12,17 @@ The **Flutter Build for Android** step automates the generation of Android APK ( ### Prerequisites -Before running the **Flutter Build for Android** step, certain prerequisites must be completed. These prerequisites are detailed in the table below: +Before running the **Flutter Build for Android** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | -------------------------- | --------------------------------------------------------------------------------------------- | -| [**Git Clone**](/workflows/common-workflow-steps/#git-clone) | This step fetches the repository that needs to be built from the specified branch. It is essential for initiating the Flutter Android build process. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step fetches the repository that needs to be built from the specified branch. It is essential for initiating the Flutter Android build process. | ### Input Variables -Each component requires specific input variables for its operation. The input variables necessary for the **Flutter Build for Android** step are: +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -35,7 +35,7 @@ Each component requires specific input variables for its operation. The input va :::info -If the required variables are already defined in the **Configuration** section, there is no need to redefine them in the Workflow. For more details, see the [Build Profile Configuration Overview](/build/build-process-management/build-profile-configuration). The details you provide in the configuration will serve as input for the Android Build step. Kindly substitute the example information with your details: +If the required variables are already defined in the **Configuration** section, there is no need to redefine them in the Workflow. For more details, see the [Build Profile Configuration Overview](/build/build-process-management/build-profile-configuration). The details you provide in the configuration will serve as input for the **Android Build** step. Kindly substitute the example information with your details: @@ -43,12 +43,12 @@ If the required variables are already defined in the **Configuration** section, ### Output Variables -The outputs resulting from the operation of this component are as follows: +The output(s) resulting from the operation of this component are as follows: | Output Variable | Description | |---------------------------|---------------------------------| -| `$AC_APK_PATH` | Path of the generated APK file. | -| `$AC_AAB_PATH` | Path of the generated AAB file. | +| `AC_APK_PATH` | Path of the generated APK file. | +| `AC_AAB_PATH` | Path of the generated AAB file. | :::info @@ -62,6 +62,8 @@ To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-android-flutter-build-component +--- + ## FAQ ### How can I solve the `Out of memory error: Java heap memory` or set the heap memory during the build? diff --git a/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-ios.md b/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-ios.md index 35fa7733c..b057941e5 100644 --- a/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-ios.md +++ b/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-ios.md @@ -1,7 +1,7 @@ --- title: Flutter Build for iOS description: Learn to build iOS apps with the Flutter Build for iOS component. Ensure Flutter Install and Git Clone steps are completed first. -tags: [flutter, build, test, workflow, step] +tags: [flutter, build, ios] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,33 +12,41 @@ This step makes your Flutter project suitable for the iOS environment and builds ### Prerequisites -:::caution -Once you have compiled your app for Flutter iOS, the native environment will be built. For this reason, this step should be used before the [**Xcodebuild for Devices**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-devices-archive--export) step. -::: +Before running the **Flutter Build for iOS** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | This step will clone your project through the connected Git provider and create the `$AC_REPOSITORY_DIR` variable. | -| [**Flutter Install**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-install) | This step will install the Flutter SDK. If a version is not specified, it will install the latest **stable** version. The **Flutter SDK** package must be installed on the system. For this reason, make sure that **Flutter Build for iOS** is used after the **Flutter Install**. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step will clone your project through the connected Git provider and create the `$AC_REPOSITORY_DIR` variable. | +| [**Flutter Install**](/workflows/flutter-specific-workflow-steps/flutter-install) | This step will install the Flutter SDK. If a version is not specified, it will install the latest **stable** version. The **Flutter SDK** package must be installed on the system. For this reason, make sure that **Flutter Build for iOS** is used after the **Flutter Install**. | + +:::caution + +Once you have compiled your app for Flutter iOS, the native environment will be built. For this reason, this step should be used before the [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) step. + +::: :::danger -**Keep in mind** that this step is dependent on the Flutter Install step. If Flutter is not installed on the system, it will give a Flutter SDK not found error. + +**Keep in mind** that this step is dependent on the **Flutter Install** step. If Flutter is not installed on the system, it will give a Flutter SDK not found error. + ::: ### Input Variables -The parameters required for this step to work are given in the table below with explanations. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_FLUTTER_PROJECT_PATH` | This parameter is used as the repository path. This path is created immediately after the Git Clone step. If the Git Clone step is not used, this path cannot be found. | Required| +| `$AC_FLUTTER_PROJECT_PATH` | This parameter is used as the repository path. This path is created immediately after the **Git Clone** step. If the **Git Clone** step is not used, this path cannot be found. | Required | | `$AC_FLUTTER_BUILD_MODE` | With this variable, you can add the mode you want to build in the build command. For example: `release`. | Required | | `$AC_FLUTTER_BUILD_EXTRA_ARGS`| You can use this parameter if you want to add an extra parameter to the build command line. | Optional | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-ios-flutter-build-component diff --git a/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-web.md b/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-web.md index d8fe99d45..1a9ea8d27 100644 --- a/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-web.md +++ b/docs/workflows/flutter-specific-workflow-steps/flutter-build-for-web.md @@ -1,7 +1,7 @@ --- title: ​Flutter Build for Web description: Learn to build web apps with the Flutter Build for Web component. Ensure Flutter Install and Git Clone steps are completed first. -tags: [flutter, build, test, workflow, step] +tags: [flutter, build, web] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,12 +12,12 @@ The **Flutter Build for Web** step builds your web application using the [Flutte ### Prerequisites -There are no prerequisites required before using the **​Flutter Build for Web** step. +Before running the **​Flutter Build for Web** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| | [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step clones your project from the connected Git provider and creates the `$AC_REPOSITORY_DIR` variable, which defaults to `$AC_FLUTTER_PROJECT_DIR`. | -| [**Flutter Install**](./flutter-install) | This step installs the [Flutter SDK](https://flutter-ko.dev/development/tools/sdk/releases). If no version is specified, it installs the latest **stable** version. | +| [**Flutter Install**](/workflows/flutter-specific-workflow-steps/flutter-install) | This step installs the [Flutter SDK](https://flutter-ko.dev/development/tools/sdk/releases). If no version is specified, it installs the latest **stable** version. | @@ -29,7 +29,7 @@ This step relies heavily on the **Flutter Install** step. If the Flutter SDK is ### Input Variables -You can find all the parameters required for this step in the table below, along with detailed descriptions. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -40,9 +40,11 @@ You can find all the parameters required for this step in the table below, along ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |------------------------|-------------------------------------| -| `$AC_FLUTTER_WEB_PATH` | This path is generated after the completion of the **Flutter Build for Web** step and stores the generated web application. | +| `AC_FLUTTER_WEB_PATH` | This path is generated after the completion of the **Flutter Build for Web** step and stores the generated web application. | ### Deploying Applications to AWS Services @@ -55,7 +57,7 @@ To deploy apps to Amplify, you can use Git, manual uploads, or Amazon S3 buckets Since Appcircle supports automated Amazon S3 uploads, you can automatically deploy your apps from Appcircle to Amazon S3 and then sync your S3 bucket with Amplify Console with the following steps: -- First, set up a [Flutter Web App build](../../.././build/platform-build-guides/building-flutter-applications/building-flutter-web-applications). +- First, set up a [Flutter Web App build](/build/platform-build-guides/building-flutter-applications/building-flutter-web-applications). - Then, add an [Upload to Amazon S3 step to your workflow](/workflows/common-workflow-steps/upload-files-to-amazon-s3) and configure it to receive the web app artifact as the input of the step. - To set up Amplify Console and S3 sync, first go to Amplify and [set up a manual deployment](https://docs.aws.amazon.com/amplify/latest/userguide/manual-deploys.html). - Then, follow the steps [in this AWS blog post](https://aws.amazon.com/blogs/mobile/deploy-files-s3-dropbox-amplify-console/) to automate deployments from an S3 bucket to Amplify. diff --git a/docs/workflows/flutter-specific-workflow-steps/flutter-install.md b/docs/workflows/flutter-specific-workflow-steps/flutter-install.md index 43b3e483f..bab024fe8 100644 --- a/docs/workflows/flutter-specific-workflow-steps/flutter-install.md +++ b/docs/workflows/flutter-specific-workflow-steps/flutter-install.md @@ -1,57 +1,71 @@ --- title: Flutter Install description: This workflow step installs the specified Flutter SDK to run the Flutter CLI for subsequent analysis, build, and test operations. -tags: [flutter, build, test, workflow, step] +tags: [flutter, install, sdk] --- import Screenshot from '@site/src/components/Screenshot'; # Flutter Install -This workflow step installs the specified [**Flutter SDK**](https://docs.flutter.dev/get-started/install) to run the [**Flutter CLI**](https://docs.flutter.dev/reference/flutter-cli) for subsequent analysis, build, and test operations. The Flutter version can be specified in [Configuration](https://docs.appcircle.io/build/building-flutter-applications/#build-configuration-for-flutter-applications). +This workflow step installs the specified [**Flutter SDK**](https://docs.flutter.dev/get-started/install) to run the [**Flutter CLI**](https://docs.flutter.dev/reference/flutter-cli) for subsequent analysis, build, and test operations. The Flutter version can be specified in [Configuration](/build/platform-build-guides/building-flutter-applications#build-configuration-for-flutter-ios-applications) :::info + All Flutter versions and detailed information can be found in the [Flutter repository](https://github.com/flutter/flutter). + ::: ### Prerequisites +There are no prerequisites required before using the **Flutter Install** step. + :::caution + These steps depend on Flutter installation and can only be used after the **Flutter Install** step: -- [**Flutter Build for iOS**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-build-for-ios) -- [**Flutter Build for Android**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-build-for-android) -- [**Flutter Analyze**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-analyze) -- [**Flutter Test**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-test) -- [**Flutter Build for Web**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-build-for-web) +- [**Flutter Build for iOS**](/workflows/flutter-specific-workflow-steps/flutter-build-for-ios) +- [**Flutter Build for Android**](/workflows/flutter-specific-workflow-steps/flutter-build-for-android) +- [**Flutter Analyze**](/workflows/flutter-specific-workflow-steps/flutter-analyze) +- [**Flutter Test**](/workflows/flutter-specific-workflow-steps/flutter-test) +- [**Flutter Build for Web**](/workflows/flutter-specific-workflow-steps/flutter-build-for-web) + ::: :::danger + The steps specified in the table are steps dependent on the **Flutter Install** step. **If Flutter Install is not used before these steps**, these steps will give a **Flutter SDK not found error**. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_SELECTED_FLUTTER_VERSION`| Specifies the Flutter version to install. Defaults to: `stable`. The version you set in the [Configuration](https://docs.appcircle.io/build/building-flutter-applications/#build-configuration-for-flutter-applications) section will override this setting. | Optional | +| `$AC_SELECTED_FLUTTER_VERSION`| Specifies the Flutter version to install. Defaults to: `stable`. The version you set in the [Configuration](/build/platform-build-guides/building-flutter-applications#build-configuration-for-flutter-ios-applications) section will override this setting. | Optional | :::caution + If no specific version is specified, this step will automatically install the latest [**stable**](https://docs.flutter.dev/release/archive?tab=macos) version released by Flutter. + ::: ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |-------------------------------|------------------------------------------------| | `PATH`| PATH variable that adds the Flutter tool to your workflow. | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-flutter-install-component diff --git a/docs/workflows/flutter-specific-workflow-steps/flutter-test.md b/docs/workflows/flutter-specific-workflow-steps/flutter-test.md index c1787f0ce..ecf1b8bb7 100644 --- a/docs/workflows/flutter-specific-workflow-steps/flutter-test.md +++ b/docs/workflows/flutter-specific-workflow-steps/flutter-test.md @@ -1,7 +1,7 @@ --- title: Flutter Test description: This component allows you to run Flutter unit tests. -tags: [flutter, build, test, workflow, step] +tags: [flutter, test, unit] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,15 +12,19 @@ This component allows you to run [**Flutter Unit Tests**](https://docs.flutter.d ### Prerequisites +Before running the **Flutter Test** step, you must complete certain prerequisites, as detailed in the table below: + | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | This step will clone your project through the connected Git provider and create the `$AC_REPOSITORY_DIR` variable. | -| [**Flutter Install**](https://docs.appcircle.io/workflows/flutter-specific-workflow-steps#flutter-install) | This step will install the [Flutter SDK](https://flutter-ko.dev/development/tools/sdk/releases) release. If the version is not specified, it will install the latest **stable** version. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step will clone your project through the connected Git provider and create the `$AC_REPOSITORY_DIR` variable. | +| [**Flutter Install**](/workflows/flutter-specific-workflow-steps/flutter-install) | This step will install the [Flutter SDK](https://flutter-ko.dev/development/tools/sdk/releases) release. If the version is not specified, it will install the latest **stable** version.| :::danger + This step is particularly dependent on the Flutter Install step. If the Flutter SDK is not installed, the step will give an error that the required command was not found. + ::: ### Input Variables @@ -37,10 +41,13 @@ You can find all the parameters required for this step in the table below, with ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |-------------------------------|------------------------------------------------| -| `$AC_TEST_RESULT_PATH` | This path is created after the test results are reported. If you are using the [**Export Build Artifact**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts) step, it can be accessed directly from [**Download Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts). | +| `AC_TEST_RESULT_PATH` | This path is created after the test results are reported. If you are using the [**Export Build Artifact**](/workflows/common-workflow-steps/export-build-artifacts) step, it can be accessed directly from [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts). | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/appcenter-ios-distribution.md b/docs/workflows/ios-specific-workflow-steps/appcenter-ios-distribution.md index f27da2c1f..b453fb5e1 100644 --- a/docs/workflows/ios-specific-workflow-steps/appcenter-ios-distribution.md +++ b/docs/workflows/ios-specific-workflow-steps/appcenter-ios-distribution.md @@ -1,7 +1,7 @@ --- title: App Center iOS Distribution -description: Distribute your iOS app to App Center for testing and distribution. `Prerequisite:` Xcodebuild for Devices step. -tags: [build, test, distribute, app center, ios, workflow, step] +description: Distribute your iOS app to App Center for testing and distribution. +tags: [distribute, app center, ios, workflow, step] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,28 +12,32 @@ With this step, you can send your `IPA` and `dSYM` files to the [App Center](htt ### Prerequisites -- First, you need to use this step after the **Xcodebuild for Devices.** This is because the project is compiled and archived in the Xcodebuild for Devices step. +Before running the **App Center iOS Distrubiton** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcodebuild for Devices**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-devices-archive--export) | This step will build your application in ARM architecture and generate an `IPA` and `dSYM` file. | +| [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) | This step will build your application in ARM architecture and generate an `IPA` and `dSYM` file. | :::caution -Note that if you do not use this step after the [**Xcodebuild for Devices**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-devices-archive--export), Appcircle will not find **IPA** and **dSYM** files to distribute to the **App Center**. + +Note that if you do not use this step after the [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices), Appcircle will not find **IPA** and **dSYM** files to distribute to the **App Center**. + ::: ### Input Variables -- Inside the step, there will be some parameters that you need to configure according to your **App Center account**. You can find the list and detailed descriptions of all parameters of the step in the table below. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger -**Do not hard-code sensitive variables, such as tokens and API keys, directly to the parameters in the step.** +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. -We recommend using [Environment Variables](https://docs.appcircle.io/environment-variables/) groups for such sensitive variables. ::: @@ -45,13 +49,15 @@ We recommend using [Environment Variables](https://docs.appcircle.io/environment | `$AC_APPCENTER_APPNAME` | The name of the app. The app's name can be identified in its URL, such as `https://appcenter.ms/users/JohnDoe/apps/myapp` for a user-owned app (where **myapp** is the app name) and `https://appcenter.ms/orgs/Appcircle/apps/myapp` for an org-owned app (the owner is **myapp**). | Required | | `$AC_APPCENTER_GROUPS` | The group name parameter is the distribution of `Group Names` you opened in your App Center account. You can type in which group you want to send it to. | Optional | | `$AC_APPCENTER_STORE` | Name of the store (App Store, Google Play, Intune). You can submit directly to this variable by giving one of the store names in your App Center account. | Optional | -| `AC_APPCENTER_RELEASE_NOTES_PATH` | If you use the `Publish Release Notes` component before this step, release-notes.txt will be used as release notes. | Optional | +| `$AC_APPCENTER_RELEASE_NOTES_PATH` | If you use the `Publish Release Notes` component before this step, release-notes.txt will be used as release notes. | Optional | | `$AC_APPCENTER_UPLOAD_DSYM` | The user can decide whether to upload your `dSYM` file. This parameter uploads the `dSYM` file automatically. The default value is **true**. | Optional | | `$AC_APPCENTER_MANDATORY` | This parameter specifies whether the update should be considered mandatory or not. The default value is **false**. | Optional | | `$AC_APPCENTER_NOTIFY` | This parameter sends notifications to testers. The default value is **true**. | Optional | -| `AC_APPCENTER_VERSION` | The latest version will be used if no version is set. | Optional | -| `AC_APPCENTER_EXTRA` | Extra command line arguments for App Center. For example, add `--debug` for verbose logs. | Optional | +| `$AC_APPCENTER_VERSION` | The latest version will be used if no version is set. | Optional | +| `$AC_APPCENTER_EXTRA` | Extra command line arguments for App Center. For example, add `--debug` for verbose logs. | Optional | + +--- To access the source code of this component, please use the following link: -[https://github.com/appcircleio/appcircle-ios-appcenter-distribute-component](https://github.com/appcircleio/appcircle-ios-appcenter-distribute-component) \ No newline at end of file +https://github.com/appcircleio/appcircle-ios-appcenter-distribute-component \ No newline at end of file diff --git a/docs/workflows/ios-specific-workflow-steps/appdome-build-to-secure-for-ios.md b/docs/workflows/ios-specific-workflow-steps/appdome-build-to-secure-for-ios.md index 44ed1289b..78aaf167d 100644 --- a/docs/workflows/ios-specific-workflow-steps/appdome-build-to-secure-for-ios.md +++ b/docs/workflows/ios-specific-workflow-steps/appdome-build-to-secure-for-ios.md @@ -16,28 +16,32 @@ https://appcircle.io/blog/elevate-your-mobile-app-security-with-appdome-integrat ### Prerequisites -The workflow steps that need to be executed before running the **Appdome Build-2Secure for iOS** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Appdome Build-2Secure for iOS** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | -| [Xcodebuild for Devices](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) | The app required for this step is generated by the **Xcodebuild for Devices** (or alternative build steps). | +| [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) | The app required for this step is generated by the **Xcodebuild for Devices** (or alternative build steps). | :::danger + If a step other than the **Xcodebuild for Devices** step is used to build or sign the app, then the **Appdome Build-2Secure for iOS** step depends on this step. + ::: ### Input Variables -This stepper needs the necessary parameters to operate. You can find all parameters and their detailed descriptions in the table below. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger -**Do not hard-code sensitive variables, such as tokens and API keys, directly to the parameters in the step.** +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. -We recommend using [Environment Variables](/environment-variables/) groups for such sensitive variables. ::: | Variable Name | Description | Status | @@ -54,14 +58,22 @@ We recommend using [Environment Variables](/environment-variables/) groups for s ### Output Variables -The outputs that can result from the operation of this component are listed as follows: +The output(s) resulting from the operation of this component are as follows: :::caution -To view the output artifacts on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your Workflow after this step. + +To view the output artifacts on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your workflow after this step. + ::: | Variable Name | Description | Status | | -------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_APPDOME_SECURED_IPA_PATH` | Local path of the secured .ipa file. Available when 'Signing Method' set to `On-Appdome` or `Private-Signing` | Required | -| `$AC_APPDOME_PRIVATE_SIGN_SCRIPT_PATH` | TLocal path of the .sh sign script file. Available when `Signing Method` set to `Auto-Dev-Signing` | Required | -| `$AC_APPDOME_CERTIFICATE_PATH` | Local path of the Certified Secure Certificate `.pdf` file | Required | +| `AC_APPDOME_SECURED_IPA_PATH` | Local path of the secured `.ipa` file. Available when 'Signing Method' set to `On-Appdome` or `Private-Signing`. | Required | +| `AC_APPDOME_PRIVATE_SIGN_SCRIPT_PATH` | TLocal path of the `.sh` sign script file. Available when `Signing Method` set to `Auto-Dev-Signing`. | Required | +| `AC_APPDOME_CERTIFICATE_PATH` | Local path of the Certified Secure Certificate `.pdf` file. | Required | + +--- + +To access the source code of this component, please use the following link: + +https://github.com/appcircleio/appcircle-ios-appdome-component diff --git a/docs/workflows/ios-specific-workflow-steps/audit-permission-change.md b/docs/workflows/ios-specific-workflow-steps/audit-permission-change.md index 8f249946c..a912e9366 100644 --- a/docs/workflows/ios-specific-workflow-steps/audit-permission-change.md +++ b/docs/workflows/ios-specific-workflow-steps/audit-permission-change.md @@ -1,7 +1,7 @@ --- title: Audit Permission Changes description: Track and audit permission changes effectively. Ensure security and compliance with our guide on monitoring access rights alterations. -tags: [cocoapods, install, workflow, step] +tags: [audit, permission, changes, workflow, step] --- import Screenshot from '@site/src/components/Screenshot'; @@ -18,7 +18,7 @@ Before running the **Audit Permission Changes** step, you must complete certain | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | You need to clone the repository to start the Audit Permission Changes process. After cloning, the system installs CocoaPods. After this step works, the variable `AC_REPOSITORY_DIR` will be created. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | You need to clone the repository to start the **Audit Permission Changes** step. After cloning, the system installs CocoaPods. After this step works, the variable `$AC_REPOSITORY_DIR` will be created. | @@ -32,16 +32,17 @@ The **Audit Permission Changes** component will automatically break the pipeline ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| | `$AC_REFERENCE_BRANCH` | Specifies the reference branch to check permissions. | Required | -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [Git Clone](/workflows/common-workflow-steps/git-clone) step. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | | `$AC_PROJECT_PATH` | Specifies the project path. For example: `./appcircle.xcodeproj` | Required | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/azure-bot-for-swiftlint.md b/docs/workflows/ios-specific-workflow-steps/azure-bot-for-swiftlint.md index a9c11f249..ac67c7601 100644 --- a/docs/workflows/ios-specific-workflow-steps/azure-bot-for-swiftlint.md +++ b/docs/workflows/ios-specific-workflow-steps/azure-bot-for-swiftlint.md @@ -1,30 +1,36 @@ --- title: Azure Bot for Swiftlint description: Integrate Azure DevOps Bot with SwiftLint to analyze and report details under PRs. Automate builds with configured triggers. -tags: [ios, build, test, workflow, step] +tags: [ios, azure, bot, swiftlint, workflow, step] --- import Screenshot from '@site/src/components/Screenshot'; # Azure Bot for Swiftlint -With the Azure DevOps Bot for Swiftlint integration, you can analyze your [**SwiftLint**](https://github.com/realm/SwiftLint/) and post the report details under the opened PR. You can also modify the PR status. +With the **Azure DevOps Bot for Swiftlint** integration, you can analyze your [**SwiftLint**](https://github.com/realm/SwiftLint/) and post the report details under the opened PR. You can also modify the PR status. :::info + This component will work in builds that are automatically triggered by a configured trigger. To achieve this, you need to open a PR and set up the trigger. Further information for **Trigger Build**, please follow the [documantation](/build/build-process-management/build-manually-or-with-triggers/). + ::: :::caution + If there are warnings or errors in the SwiftLint report, this workflow step will fail and stop the build. + ::: :::danger + For this component to work, a PR must be opened, and a trigger must be set up based on this PR. If the build is triggered manually, the component will not function. + ::: ### Prerequisites -The workflow steps that need to be executed before running the **Swiftlint** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Azure Bot for Swiftlint** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| @@ -34,14 +40,16 @@ The workflow steps that need to be executed before running the **Swiftlint** wor ### Input Variables -This component needs some parameters to operate. You can find the required parameters and their detailed descriptions in the list below. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger -**Do not hard-code sensitive variables, such as tokens and API keys, directly to the parameters in the step.** +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. -We recommend using [Environment Variables](/environment-variables/) groups for such sensitive variables. ::: | Variable Name | Description | Status | @@ -55,6 +63,8 @@ We recommend using [Environment Variables](/environment-variables/) groups for s | `$AC_DOMAIN_NAME` | Specifies the domain name of Appcircle. The default value is `my.appcircle.io`, which is the domain for Appcircle Cloud. | Required | | `$AC_AZURE_API_VERSION` | Specifies the version of the Azure API, for example: `7.1`. Refer to the [REST API versioning](https://learn.microsoft.com/en-us/azure/devops/integrate/concepts/rest-api-versioning) document for more information. | Required | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-ios-azure-bot-for-swiftlint-component diff --git a/docs/workflows/ios-specific-workflow-steps/browserstack-app-automation.md b/docs/workflows/ios-specific-workflow-steps/browserstack-app-automation.md index cd3a157fb..a11a3c814 100644 --- a/docs/workflows/ios-specific-workflow-steps/browserstack-app-automation.md +++ b/docs/workflows/ios-specific-workflow-steps/browserstack-app-automation.md @@ -13,35 +13,45 @@ Run your [**XCUI**](https://developer.apple.com/documentation/xctest/user_interf ### Prerequisites +Before running the **BrowserStack App Automate (XCUI)** step, you must complete certain prerequisites, as detailed in the table below: + | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcodebuild for Testing**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-testing) | After the [**Xcodebuild for Testing**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-testing) step runs, the test IPA paths (`$AC_TEST_IPA_PATH` and `$AC_UITESTS_RUNNER_PATH`) will be created automatically. So that the **BrowserStack** component depends on these paths. | +| [**Xcodebuild for Testing**](/workflows/ios-specific-workflow-steps/xcodebuild-for-testing) | After the [**Xcodebuild for Testing**](/workflows/ios-specific-workflow-steps/xcodebuild-for-testing) step runs, the test IPA paths (`$AC_TEST_IPA_PATH` and `$AC_UITESTS_RUNNER_PATH`) will be created automatically. So that the **BrowserStack** component depends on these paths. | :::danger + In the build step, if there is no **Xcodebuild Build for Testing** step before **BrowserStack**, **BrowserStack** will throw an **error** and **break the pipeline** because it cannot find the paths that your step depends on. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +The output(s) resulting from the operation of this component are as follows: -:::danger -Do not specify the **Access Key** directly in a hard coded format in steps. Please use [**Environment Variables**](https://docs.appcircle.io/environment-variables/) when using potentially *sensitive variables* like this. +:::danger Sensitive Variables + +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. + +We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. + ::: | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|--------| | `$AC_BROWSERSTACK_USERNAME` | Username of the **BrowserStack** account. It should come from the **BrowserStack** account. | Required | | `$AC_BROWSERSTACK_ACCESS_KEY` | Access key for the **BrowserStack** account. It should come from the **BrowserStack** account. For more information, please follow [this document](https://www.browserstack.com/docs/iaam/security/manage-access-keys). | Required | -| `$AC_TEST_IPA_PATH` | Full path of the IPA file. This path will automatically generate in [**Xcodebuild for Testing**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-testing) step.| Required | -| `$AC_UITESTS_RUNNER_PATH` | Full path of the *-Runner.app. This path will automatically generate in [**Xcodebuild for Testing**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-testing) step. | Required | -| `$AC_BROWSERSTACK_PAYLOAD` | `AC_BROWSERSTACK_APP_URL` and `AC_BROWSERSTACK_TEST_URL` will be auto generated. Please check the [documentation](https://www.browserstack.com/docs/app-automate/api-reference/xcuitest/builds#execute-a-build) for more details about the payload. | Optional | +| `$AC_TEST_IPA_PATH` | Full path of the IPA file. This path will automatically generate in [**Xcodebuild for Testing**](/workflows/ios-specific-workflow-steps/xcodebuild-for-testing) step.| Required | +| `$AC_UITESTS_RUNNER_PATH` | Full path of the *-Runner.app. This path will automatically generate in [**Xcodebuild for Testing**](/workflows/ios-specific-workflow-steps/xcodebuild-for-testing) step. | Required | +| `$AC_BROWSERSTACK_PAYLOAD` | `$AC_BROWSERSTACK_APP_URL` and `$AC_BROWSERSTACK_TEST_URL` will be auto generated. Please check the [documentation](https://www.browserstack.com/docs/app-automate/api-reference/xcuitest/builds#execute-a-build) for more details about the payload. | Optional | | `$AC_BROWSERSTACK_TIMEOUT` | **BrowserStack** plans a timeout in seconds. If there is any problem in BrowserStack, these variables will break the pipeline after a certain time. The default variable is **600 seconds**. | Required | +--- + To access the source code of this component, please use the following link: -[https://github.com/appcircleio/appcircle-browserstack-xcui-component](https://github.com/appcircleio/appcircle-browserstack-xcui-component) \ No newline at end of file +https://github.com/appcircleio/appcircle-browserstack-xcui-component \ No newline at end of file diff --git a/docs/workflows/ios-specific-workflow-steps/carthage.md b/docs/workflows/ios-specific-workflow-steps/carthage.md index cf4b0b194..6f80680b8 100644 --- a/docs/workflows/ios-specific-workflow-steps/carthage.md +++ b/docs/workflows/ios-specific-workflow-steps/carthage.md @@ -14,26 +14,34 @@ import Screenshot from '@site/src/components/Screenshot'; ### Prerequisites -Appcircle will look for a [`Cartfile`](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md) file in your repository and use it to install the dependencies. For this reason, **it should be used after the Git Clone step**. +Before running the **Carthage** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) | This step clones your git repo on the runner where the build process will take place so that the necessary workflow operations can be performed. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step clones your git repo on the runner where the build process will take place so that the necessary workflow operations can be performed. | +:::caution + +Appcircle will look for a [`Cartfile`](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md) file in your repository and use it to install the dependencies. For this reason, **it should be used after the Git Clone step**. + +::: + ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_CARTHAGE_COMMAND` | Specifies the Carthage command to run. Defaults to `bootstrap`. **Possible values:** `bootstrap`, `update` | Required | -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone).| Optional | -| `$AC_CARTFILE_PATH` | Specifies the path where the Cartfile resides. Defaults to the repository directory. **DO NOT** include Cartfile, this is only the path. **This value will be appended** to `AC_REPOSITORY_DIR`. **Example:** `./` or `./subpath-to-cartfile/` | Optional | -| `$AC_CARTHAGE_FLAGS` | Specifies additional flags after the Carthage command. The default value is empty. **For Xcode 12 and above, make sure to include** `--use-xcframeworks` **here**. To shorten the build time, make sure to specify the platform: `--platform iOS`. Example usage: `--platform iOS --use-xcframeworks` | Optional | +| `$AC_CARTHAGE_COMMAND` | Specifies the Carthage command to run. Defaults to `bootstrap`. **Possible values:** `bootstrap`, `update`. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after [**Git Clone**](/workflows/common-workflow-steps/git-clone).| Optional | +| `$AC_CARTFILE_PATH` | Specifies the path where the Cartfile resides. Defaults to the repository directory. **DO NOT** include Cartfile, this is only the path. **This value will be appended** to `$AC_REPOSITORY_DIR`. **Example:** `./` or `./subpath-to-cartfile/`. | Optional | +| `$AC_CARTHAGE_FLAGS` | Specifies additional flags after the Carthage command. The default value is empty. **For Xcode 12 and above, make sure to include** `--use-xcframeworks` **here**. To shorten the build time, make sure to specify the platform: `--platform iOS`. Example usage: `--platform iOS --use-xcframeworks`. | Optional | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/cocoapods-deintegrate.md b/docs/workflows/ios-specific-workflow-steps/cocoapods-deintegrate.md index 9cbc67f2d..877b7044a 100644 --- a/docs/workflows/ios-specific-workflow-steps/cocoapods-deintegrate.md +++ b/docs/workflows/ios-specific-workflow-steps/cocoapods-deintegrate.md @@ -18,7 +18,7 @@ Before running the **CocoaPods Deintegrate** step, you must complete certain pre | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | The repo needs to be cloned in order to start the CocoaPods Deintegrate process. After the clone, Fastlane will be installed. After this step works, the variable `AC_REPOSITORY_DIR` will be created.| +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repo needs to be cloned in order to start the CocoaPods Deintegrate process. After the clone, Fastlane will be installed. After this step works, the variable `$AC_REPOSITORY_DIR` will be created.| :::caution @@ -30,16 +30,17 @@ Please remember to use the [**CocoaPods Install**](/workflows/ios-specific-workf ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| | `$AC_XCODEPROJ_PATH` | Specifies the project path. For example: `./appcircle.xcodeproj`. Empty value will look for an `.xcodeproj` file. | Optional | -| `$AC_REPOSITORY_DIR` | Specifies the directory where the repository is cloned. This path is generated after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Optional | +| `$AC_REPOSITORY_DIR` | Specifies the directory where the repository is cloned. This path is generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Optional | | `$AC_COCOAPODS_VERSION` | Specifies the CocoaPods version. If you need a specific version, provide it here as hardcoded, and the system will automatically install that version. | Optional | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md b/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md index 46f846616..5ec0e730a 100644 --- a/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md +++ b/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md @@ -8,38 +8,44 @@ import Screenshot from '@site/src/components/Screenshot'; # Cocoapods Install -Runs the [CocoaPods](https://cocoapods.org) install command for dependency management. This step installs all pod dependencies. Appcircle uses the `pod install` command to install pods in the project. This command comes from the CocoaPods tool installed on the system. If a version is not specified for CocoaPods, this step will use the version of [**CocoaPods installed**](https://docs.appcircle.io/infrastructure/ios-build-infrastructure#ios-build-agent-stacks) on the system. +Runs the [CocoaPods](https://cocoapods.org) install command for dependency management. This step installs all pod dependencies. Appcircle uses the `pod install` command to install pods in the project. This command comes from the CocoaPods tool installed on the system. If a version is not specified for CocoaPods, this step will use the version of [**CocoaPods installed**](/infrastructure/ios-build-infrastructure#ios-build-agent-stacks) on the system. ### Prerequisites -The workflow steps that need to be executed before running the **Cocoapods Install** workflow step, along with their respective reasons, are listed in the table below. +Before running the **Cocoapods Install** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | The repo needs to be cloned in order to start the CocoaPods installation process. After the clone, CocoaPods will be installed. After this step works, the variable `AC_REPOSITORY_DIR` will be created. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repo needs to be cloned in order to start the CocoaPods installation process. After the clone, CocoaPods will be installed. After this step works, the variable `$AC_REPOSITORY_DIR` will be created. | ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_PROJECT_PATH` | Specifies the project path. For example: `./appcircle.xcodeproj`. If you filled in **`Configuration => Project or Workspace`**, this variable comes from [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration). | Required | -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Required | +| `$AC_PROJECT_PATH` | Specifies the project path. For example: `./appcircle.xcodeproj`. If you filled in **`Configuration => Project or Workspace`**, this variable comes from [Configuration](/build/build-process-management/build-profile-configuration). | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | | `$AC_COCOAPODS_VERSION` | Specifies the CocoaPods version. If there is a specific version you want to use, give it here as hardcoded, and the system will automatically install the given version. | Optional | :::info -Please note that the CocoaPods Install step uses the default system [**CocoaPods version**](https://docs.appcircle.io/infrastructure/ios-build-infrastructure#ios-build-agent-stacks). If you want to use a specific version, please enter it hardcoded in the CocoaPods Version parameter in the step. + +Please note that the **CocoaPods Install** step uses the default system [**CocoaPods version**](/infrastructure/ios-build-infrastructure#ios-build-agent-stacks). If you want to use a specific version, please enter it hardcoded in the CocoaPods Version parameter in the step. + ::: :::danger + Remember, if the project extension is not **.xcworkpace**, the pod install step will not work as expected. In the Configuration tab, make sure that the extension in the project path is **.xcworkspace**. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-cocoapods-component diff --git a/docs/workflows/ios-specific-workflow-steps/convert-xcresult-to-xml-html.md b/docs/workflows/ios-specific-workflow-steps/convert-xcresult-to-xml-html.md index f09c2292c..867ef8ce3 100644 --- a/docs/workflows/ios-specific-workflow-steps/convert-xcresult-to-xml-html.md +++ b/docs/workflows/ios-specific-workflow-steps/convert-xcresult-to-xml-html.md @@ -8,23 +8,28 @@ import Screenshot from '@site/src/components/Screenshot'; # Convert Xcresult to HTML/XML -After the [**Xcodebuild for Unit and UI Tests**](https://docs.appcircle.io/continuous-testing/running-ios-unit-and-ui-tests) step runs, it generates a `test_result.xcresult` file. In specific cases, this test file must be converted to another format. The **Convert Xcresult to HTML/XML** step is used for converting this test file to `HTML` and `XML` formats. +After the [**Xcodebuild for Unit and UI Tests**](/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test) step runs, it generates a `test_result.xcresult` file. In specific cases, this test file must be converted to another format. The **Convert Xcresult to HTML/XML** step is used for converting this test file to `HTML` and `XML` formats. ### Prerequisites + +Before running the **Convert Xcresult to HTML/XML** step, you must complete certain prerequisites, as detailed in the table below: + | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcodebuild for Unit and UI Tests**](https://docs.appcircle.io/continuous-testing/running-ios-unit-and-ui-tests) | This step allows you to run unit and UI tests on your project. After this step runs, the related path, `AC_TEST_RESULT_PATH` will be generated automatically. | +| [**Xcodebuild for Unit and UI Tests**](/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test) | This step allows you to run unit and UI tests on your project. After this step runs, the related path, `$AC_TEST_RESULT_PATH` will be generated automatically. | :::caution + Please note that if you do not run **Xcodebuild for Unit and UI Tests** before this step, the step will produce an error because there will be no test result file to convert. + ::: ### Input Variables -The parameters required for the operation of this stepper are given below with explanations. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -39,14 +44,20 @@ The parameters required for the operation of this stepper are given below with e ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |-------------------------------|-------------------------------------| -| `$AC_CONVERTED_TEST_RESULT_PATH` | Specifies the path where the converted result is stored. Users can access this path via this variable. Additionally, it will be available for download in the [**Download Artifact**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) section. | +| `AC_CONVERTED_TEST_RESULT_PATH` | Specifies the path where the converted result is stored. Users can access this path via this variable. Additionally, it will be available for download in the [**Download Artifact**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) section. | :::caution -To view the converted test reports on the [**Download Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts/#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](https://docs.appcircle.io/workflows/common-workflow-steps/export-build-artifacts) step is included in your Workflow after this step. + +To view the converted test reports on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your workflow after this step. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-ios-xcresult-convert-html-xml-component \ No newline at end of file diff --git a/docs/workflows/ios-specific-workflow-steps/firebase-upload-dsym.md b/docs/workflows/ios-specific-workflow-steps/firebase-upload-dsym.md index 61b87c2f3..ea5b8cb24 100644 --- a/docs/workflows/ios-specific-workflow-steps/firebase-upload-dsym.md +++ b/docs/workflows/ios-specific-workflow-steps/firebase-upload-dsym.md @@ -12,21 +12,23 @@ This step allows to upload your debug symbols to [**Firebase Crashlytics**](http ### Prerequisites -The workflow steps that need to be executed before running the `Firebase Upload dSYM` workflow step, along with their respective reasons, are listed in the table below. +Before running the **Firebase Upload dSYM** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcodebuild for Devices**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/#xcodebuild-for-devices-archive--export) | This step will build your application, create an Archive file, and generate `.ipa`. The Archive file contains the `.dSYM` file. Please use **Firebase Upload dSYM** step after this step. | +| [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) | This step will build your application, create an Archive file, and generate `.ipa`. The Archive file contains the `.dSYM` file. Please use **Firebase Upload dSYM** step after this step. | :::danger + If this step is not used after **Xcodebuild for Devices**, the pipeline will give error. Because the dSYM file is generated after the project is archived. + ::: ### Input Variables -You can find all the parameters required for this step in the table below with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -36,16 +38,20 @@ You can find all the parameters required for this step in the table below with t | `$AC_FIREBASE_CRASHLYTICS_PATH` | This path parameter specifies the path of the generated dSYM file. | Required | :::info + Crashlytics paths change depending on the platform. According to the mobile application platform you are working on, you need to provide one of the following paths here. -|Project Type|Crashlytics Paths for Platforms| -|------------|----| -|Native iOS CocoaPods|$AC_REPOSITORY_DIR/Pods/FirebaseCrashlytics/upload-symbols| -|Native iOS SPM|$HOME/Library/Developer/Xcode/DerivedData/**/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/upload-symbols| -|React Native iOS|$AC_REPOSITORY_DIR/ios/Pods/FirebaseCrashlytics/upload-symbols| -|Flutter iOS|$AC_REPOSITORY_DIR/ios/Pods/FirebaseCrashlytics/upload-symbols| +| Project Type | Crashlytics Paths for Platforms | +|----------------------|-------------------------------------------------------------------------------------------------------------------| +| Native iOS CocoaPods | $AC_REPOSITORY_DIR/Pods/FirebaseCrashlytics/upload-symbols | +| Native iOS SPM | $HOME/Library/Developer/Xcode/DerivedData/**/SourcePackages/checkouts/firebase-ios-sdk/Crashlytics/upload-symbols | +| React Native iOS | $AC_REPOSITORY_DIR/ios/Pods/FirebaseCrashlytics/upload-symbols | +| Flutter iOS | $AC_REPOSITORY_DIR/ios/Pods/FirebaseCrashlytics/upload-symbols | + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-firebase-dsym-upload-component \ No newline at end of file diff --git a/docs/workflows/ios-specific-workflow-steps/index.md b/docs/workflows/ios-specific-workflow-steps/index.md index e2f0fc789..dab01cd9b 100644 --- a/docs/workflows/ios-specific-workflow-steps/index.md +++ b/docs/workflows/ios-specific-workflow-steps/index.md @@ -123,8 +123,7 @@ This step installs [SwiftLint](https://github.com/realm/SwiftLint/) and runs swi This component provides detailed reports and insights on the results of iOS app tests conducted. For detailed information on the usage of **Test Reports for iOS**, please refer to the documentation: - -[https://docs.appcircle.io/continuous-testing/running-ios-unit-and-ui-tests#generating-test-report](https://docs.appcircle.io/continuous-testing/running-ios-unit-and-ui-tests#generating-test-report) +- [Generating Test Report](/continuous-testing/ios-testing/running-ios-unit-and-ui-tests#generating-test-report) Test Reports for iOS diff --git a/docs/workflows/ios-specific-workflow-steps/install-certificates-provisions.md b/docs/workflows/ios-specific-workflow-steps/install-certificates-provisions.md index 7b3f1d570..f0dd048d8 100644 --- a/docs/workflows/ios-specific-workflow-steps/install-certificates-provisions.md +++ b/docs/workflows/ios-specific-workflow-steps/install-certificates-provisions.md @@ -1,7 +1,7 @@ --- title: Install Certificates and Provisioning Profiles description: Learn how to install certificates and provisioning profiles for iOS distribution in Appcircle. -tags: [build, test, distribute, ios, workflow, step] +tags: [ios, provision, certificate, install, keychain, profiles, signing] --- import Screenshot from '@site/src/components/Screenshot'; @@ -13,16 +13,22 @@ For more detailed information on **iOS Certificates and Provisioning Profiles**, ### Prerequisites +Before running the **Install Certificates and Provisioning Profiles** step, you must complete certain prerequisites, as detailed in the table below: + :::info + If you are using an automatic code sign, you can remove this step. Since automatic code signing is managed by Xcode, this step will not be needed. + ::: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | Clone your repository to the runner machine. Use the Install Certificates and Provisiong Profiles step after this step. This step will clone your repository to be able to use provisioning profiles and certificates. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | Clone your repository to the runner machine. Use the Install Certificates and Provisiong Profiles step after this step. This step will clone your repository to be able to use provisioning profiles and certificates. | :::danger + Please remember. If you are using **manual sign**, you should definitely use this step and run it after the **Git Clone** step. + ::: @@ -30,7 +36,7 @@ Please remember. If you are using **manual sign**, you should definitely use thi ### Input Variables -The parameters required for this step to work are listed in the table below. These parameters are defaults. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -43,14 +49,16 @@ The parameters required for this step to work are listed in the table below. The ### Output Variables -The output parameters after this step is executed are as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | |-------------------------------|------------------------------------------------| -| `$AC_KEYCHAIN_PATH` | A path is created after the certificate is added to the current runner's keychain. | -| `$AC_KEYCHAIN_PASSWORD` | After this certificate is added to the keychain, the password assigned to the keychain | +| `AC_KEYCHAIN_PATH` | A path is created after the certificate is added to the current runner's keychain. | +| `AC_KEYCHAIN_PASSWORD` | After this certificate is added to the keychain, the password assigned to the keychain. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/ios-increment-build-and-version-number.md b/docs/workflows/ios-specific-workflow-steps/ios-increment-build-and-version-number.md index 58b230608..7fcd864ba 100644 --- a/docs/workflows/ios-specific-workflow-steps/ios-increment-build-and-version-number.md +++ b/docs/workflows/ios-specific-workflow-steps/ios-increment-build-and-version-number.md @@ -1,17 +1,18 @@ --- title: iOS Increment Build and Version Number description: Learn how to increment the version code and version name of an iOS application in Appcircle -tags: [versioning, ios, build version, version code, version name] +tags: [versioning, ios, build version, version code, version name, increment] --- import Screenshot from '@site/src/components/Screenshot'; # iOS Increment Build and Version Number -The **iOS Increment Build and Version Number** step is controlled by **iOS Versioning**. For detailed information about this step, including [**Prerequisites**](/versioning/ios-version#enabling-version-management), [**Input Variables**](/versioning/ios-version#input-variables), and[**Output Variables**](/versioning/ios-version#output-values), please refer to the documentation below: +The **iOS Increment Build and Version Number** step is controlled by **iOS Versioning**. For detailed information about this step, including [**Prerequisites**](/versioning/ios-version#enabling-version-management), [**Input Variables**](/versioning/ios-version#input-variables), and [**Output Variables**](/versioning/ios-version#output-values), please refer to the documentation below: - [**Understanding iOS Versioning**](/versioning/ios-version) +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/slather.md b/docs/workflows/ios-specific-workflow-steps/slather.md index 0d529c3ce..e28343792 100644 --- a/docs/workflows/ios-specific-workflow-steps/slather.md +++ b/docs/workflows/ios-specific-workflow-steps/slather.md @@ -1,7 +1,7 @@ --- title: Slather description: Use Slather to convert Xcode's test results into various formats. Prerequisites include Xcodebuild for Tests and Git Clone. -tags: [ios, build, test, workflow, step] +tags: [slather, ios, build, test, unit, ui, testing, step] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,35 +12,40 @@ This step converts Xcode's test results to different formats by using [**Slather ### Prerequisites -| Prerequisite Workflow Step | Description | -|-------------------------------------------------|-------------------------------------------------| -| [**Xcodebuild for Unit and UI Tests**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-unit-and-ui-tests) | This step executes your unit and UI tests, generating a `.xcresult` file. This file serves as the mandatory test result input for **Slather**. | -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | This step will clone your repository. After this step works, the variable `AC_REPOSITORY_DIR` will be created. This variable is the required input variable for **Slather**. | +Before running the **Slather** step, you must complete certain prerequisites, as detailed in the table below: + +| Prerequisite Workflow Step | Description | +|------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step will clone your repository. After this step works, the variable `$AC_REPOSITORY_DIR` will be created. This variable is the required input variable for **Slather**. | +| [**Xcodebuild for Unit and UI Tests**](/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test) | This step executes your unit and UI tests, generating a `.xcresult` file. This file serves as the mandatory test result input for **Slather**. | :::danger + **Slather** component needs test results in `.xcresult` format to work. Therefore, make sure that the tests of the project are run. Otherwise, **Slather** will throw an error for not finding the file and the pipeline will break. + ::: ## Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------|--------------------------------------|----------------------------------| | `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. It's generated after the **Git Clone** step. | Required | -| `$AC_TEST_RESULT_PATH` | This is the path of **`.xcresult`** file. It will be generated after the [**Xcodebuild for Unit and UI Test**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-unit-and-ui-tests) step. | Required | -| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in `Config => Build Schema` in the Configuration, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). | Required | -| `$AC_PROJECT_PATH` | Specifies the project path. For example: **`./appcircle.xcodeproj`**. If you filled in `Config => Xcode Project or Workspace Path` in the Configuration, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). But if you have a different location, specify this parameter. | Required | -| `$AC_WORKSPACE_PATH` | Specifies the workspace path. For example : **`./appcircle.xcworkspace`**. If you filled in `Config => Xcode Project or Workspace Path` in the Configuration, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). But if you have a different location, specify this parameter. | Optional | +| `$AC_TEST_RESULT_PATH` | This is the path of **`.xcresult`** file. It will be generated after the [**Xcodebuild for Unit and UI Test**](/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test) step. | Required | +| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in `Config => Build Schema` in the Configuration, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Required | +| `$AC_PROJECT_PATH` | Specifies the project path. For example: **`./appcircle.xcodeproj`**. If you filled in `Config => Xcode Project or Workspace Path` in the Configuration, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). But if you have a different location, specify this parameter. | Required | +| `$AC_WORKSPACE_PATH` | Specifies the workspace path. For example : **`./appcircle.xcworkspace`**. If you filled in `Config => Xcode Project or Workspace Path` in the Configuration, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). But if you have a different location, specify this parameter. | Optional | | `$AC_COVERAGE_FORMAT` | Exported coverage format. You can change the output format of the coverage test results for Slather with the **Coverage Type** variable. The default value is **cobertura**. | Optional | | `$AC_CONFIGURATION_NAME`| If you have a configuration that you want to specify while **Slather** is running, you can add it to the command line with the **Configuration** parameter. | Optional | | `$AC_SLATHER_OPTIONS` | If you want to add an extra command to the command line, you can do it with the **Extra Option** variable. | Optional | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/swiftlint.md b/docs/workflows/ios-specific-workflow-steps/swiftlint.md index 8f6d5d656..44640a436 100644 --- a/docs/workflows/ios-specific-workflow-steps/swiftlint.md +++ b/docs/workflows/ios-specific-workflow-steps/swiftlint.md @@ -1,7 +1,7 @@ --- title: SwiftLint -description: Improve your code with SwiftLint, a tool for identifying programmatic and stylistic errors. Prerequisites include Git Clone and Cocoapods Install. -tags: [ios, build, test, workflow, step] +description: Improve your code with SwiftLint, a tool for identifying programmatic and stylistic errors. +tags: [ios, build, lint, error] --- import Screenshot from '@site/src/components/Screenshot'; @@ -11,27 +11,32 @@ SwiftLint checks the source code for programmatic as well as stylistic errors. T ### Prerequisites -Remember, SwiftLint must be used after the following steps in order to work as expected. +Before running the **SwiftLint** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | The repo needs to be cloned in order to start the CocoaPods installation process. After the clone, CocoaPods will be installed, and then SwiftLint will be run. After this step works, the variable `AC_REPOSITORY_DIR` will be created. This variable is the input variable for CocoaPods and SwiftLint. | -| [Cocoapods Install](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#cocoapods-install)| This step will install the dependencies in the project before SwiftLint can run. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | This step will clone your repository. After this step works, the variable `$AC_REPOSITORY_DIR` will be created. This variable is the required input variable for **SwiftLint**. | +| [**Cocoapods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install)| This step will install the dependencies in the project before **SwiftLint** can run. | :::danger -If you are using **CocoaPods**, note that this step is dependent on the [**CocoaPods Install**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#cocoapods-install) step. Otherwise, the SwiftLint component will **fail**, and the **pipeline will break.** + +If you are using **CocoaPods**, note that this step is dependent on the [**CocoaPods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) step. Otherwise, the **SwiftLint** component will **fail**, and the **pipeline will break.** + ::: + :::caution -If you are using **Swift Package Manager (SPM)**, do not use this step. SPM packages will be compiled in other steps that work with **Xcode**, such as [**Xcodebuild for Devices**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcodebuild-for-devices-archive--export). -If you have SPM in your project and you are using the SwiftLint component in your workflow, the Linter component will give an error because it cannot find the required dependencies. +If you are using **Swift Package Manager (SPM)**, do not use this step. SPM packages will be compiled in other steps that work with **Xcode**, such as [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices). + +If you have SPM in your project and you are using the **SwiftLint** component in your workflow, the Linter component will give an error because it cannot find the required dependencies. + ::: ### Input Variables -You can also customize your SwiftLint step with the options in the component. You can find all the detailed descriptions for all variables in the table below. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -43,13 +48,17 @@ You can also customize your SwiftLint step with the options in the component. Yo | `$AC_LINT_CONFIG` | Specifies the linting configuration file. For example: `/.swiftlint.yml` | Optional | | `$AC_LINT_REPORTER` | You can change the report type with the `Reporter Format` option. This option supports extensions such as **`html`**, **`json`**, **`junit`**, etc. The default is **Xcode**. | Optional | | `$AC_LINT_STRICT` | If there is a failure in the running lint, you can break the pipeline with the **Strict** option. The default value is `NO`. | Optional | -| `AC_LINT_QUIET` | If you want the logs to be simpler, you can make the report file simpler with the **Quiet Mode** feature. | Optional | +| `$AC_LINT_QUIET` | If you want the logs to be simpler, you can make the report file simpler with the **Quiet Mode** feature. | Optional | ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |-------------------------------|------------------------------------------------| -| `$AC_LINT_OUTPUT_PATH` | The path of the SwfitLint results output file. After SwiftLint runs, all results will be written in a .txt file. It can be found in the download artifacts. | +| `AC_LINT_OUTPUT_PATH` | The path of the SwiftLint results output file. After **SwiftLint** runs, all results will be written in a `.txt` file. It can be found in the download artifacts. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/test-reports-for-ios.md b/docs/workflows/ios-specific-workflow-steps/test-reports-for-ios.md index fa89acfdf..a5219a762 100644 --- a/docs/workflows/ios-specific-workflow-steps/test-reports-for-ios.md +++ b/docs/workflows/ios-specific-workflow-steps/test-reports-for-ios.md @@ -22,7 +22,7 @@ For additional details, please refer to the document: [**Generating Test Report* ### Prerequisites -Before executing the **Test Report** workflow step, certain prerequisite workflow steps must be completed: +Before running the **Test Reports for iOS** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ------------------------------------------------------------ | ----------------------------------------------------------------------------- | @@ -31,22 +31,23 @@ Before executing the **Test Report** workflow step, certain prerequisite workflo ### Input Variables -For each component, specific input variables are required for its operation on your system. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ------------------------ | ---------------------------------------------------------------- | --------- | -| `AC_TEST_RESULT_PATH` | Define the directory and its subdirectories for searching compatible test files. | Required | -| `AC_COVERAGE_RESULT_PATH`| For native iOS projects, tests automatically set this variable. For other projects, you must specify the coverage path manually. | Optional | +| `$AC_TEST_RESULT_PATH` | Define the directory and its subdirectories for searching compatible test files. | Required | +| `$AC_COVERAGE_RESULT_PATH`| For native iOS projects, tests automatically set this variable. For other projects, you must specify the coverage path manually. | Optional | ### Output Variables -The outputs resulting from the operation of this component are as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | | -------------------------- | ---------------------------------------------------- | | `AC_TEST_REPORT_JSON_PATH` | Specifies the path of the JSON report. | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/tuist-commands.md b/docs/workflows/ios-specific-workflow-steps/tuist-commands.md index 0c752e127..7bae5b421 100644 --- a/docs/workflows/ios-specific-workflow-steps/tuist-commands.md +++ b/docs/workflows/ios-specific-workflow-steps/tuist-commands.md @@ -14,12 +14,12 @@ You can seamlessly integrate Tuist Commands into your workflow with Appcircle, m ### Prerequisites -Before you run the **Tuist Commands** step, you must complete certain prerequisites, as detailed in the table below: +Before running the **Tuist Commands** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |---------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | You need to clone the repository to start the Tuist Commands process. After cloning, it creates the `AC_REPOSITORY_DIR` variable, and the system is able to run the Tuist Commands. | -| [Tuist Install](/workflows/ios-specific-workflow-steps/tuist-install) | You need to install the Tuist to start the Tuist Commands process. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | You need to clone the repository to start the Tuist Commands process. After cloning, it creates the `$AC_REPOSITORY_DIR` variable, and the system is able to run the **Tuist Commands**. | +| [**Tuist Install**](/workflows/ios-specific-workflow-steps/tuist-install) | You need to install the Tuist to start the **Tuist Commands** step. | :::caution Tuist Commands @@ -35,15 +35,16 @@ For more information about Tuist CLI Commands, please visit the [**Tuist CLI**]( ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| -| `$AC_TUIST_PATH` | Specifies the path to the directory containing the project definition. This path is automatically generated after the [Git Clone](/workflows/common-workflow-steps/git-clone) step. | Required | -| `$AC_TUIST_COMMANDS` | Specifies the Tuist Commands to be able to run specific Tuist Commands. For example; `tuist test` or `tuist build`. | Required | +| `$AC_TUIST_PATH` | Specifies the path to the directory containing the project definition. This path is automatically generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | +| `$AC_TUIST_COMMANDS` | Specifies the Tuist commands to be able to run specific Tuist commands. For example; `tuist test` or `tuist build`. | Required | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/tuist-install.md b/docs/workflows/ios-specific-workflow-steps/tuist-install.md index cb36d57a9..09caed376 100644 --- a/docs/workflows/ios-specific-workflow-steps/tuist-install.md +++ b/docs/workflows/ios-specific-workflow-steps/tuist-install.md @@ -20,15 +20,15 @@ Tuist CLI tool is a tool that enables different actions to be performed in the p ### Prerequisites -Before you run the **Tuist Install** step, you must complete certain prerequisites, as detailed in the table below: +Before running the **Tuist Install** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | You need to clone the repository to start the Tuist process. After cloning, the system installs Tuist and creates the `AC_REPOSITORY_DIR` variable. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | You need to clone the repository to start the Tuist process. After cloning, the system installs Tuist and creates the `$AC_REPOSITORY_DIR` variable. | :::caution Tuist Usage -Appcircle's Tuist Install component generates your project using only the `tuist generate` command. This means that it will automatically generate the `.xcworkspace` and `.xcodeproj` files in the project after the tuist generate command runs. Note that if you use Tuist Install in the Appcircle pipeline and want to generate an **IPA** file, you need the other build steps, such as +Appcircle's Tuist Install component generates your project using only the `tuist generate` command. This means that it will automatically generate the `.xcworkspace` and `.xcodeproj` files in the project after the tuist generate command runs. Note that if you use **Tuist Install** in the Appcircle pipeline and want to generate an **IPA** file, you need the other build steps, such as - [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices) - [**Xcodebuild for iOS Simulator**](/workflows/ios-specific-workflow-steps/xcodebuild-for-ios-simulator) @@ -50,7 +50,7 @@ In Tuist integrated projects, there will be cases where `.xcworkspace` and `.xco ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). @@ -62,7 +62,7 @@ In some projects, the version of Tuist that needs to be installed and used can b :::caution Tuist Install -Appcircle uses homebrew as [installation method](https://docs.tuist.io/en/guides/quick-start/install-tuist) in Tuist Install step, therefore only compatible versions are supported. For more information, please check this [list](https://github.com/tuist/homebrew-tuist/tree/main/Formula) for compatible versions of Tuist. +Appcircle uses homebrew as [installation method](https://docs.tuist.io/en/guides/quick-start/install-tuist) in **Tuist Install** step, therefore only compatible versions are supported. For more information, please check this [list](https://github.com/tuist/homebrew-tuist/tree/main/Formula) for compatible versions of Tuist. For this reason, iOS apps using Tuist versions `1.x` or `2.x` are not supported with Appcircle's Tuist Components. @@ -70,9 +70,10 @@ For this reason, iOS apps using Tuist versions `1.x` or `2.x` are not supported | Variable Name | Description | Status | |--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| -| `$AC_TUIST_PATH` | Specifies the path to the directory containing the project definition. This path is automatically generated after the [Git Clone](/workflows/common-workflow-steps/git-clone) step. | Required | +| `$AC_TUIST_PATH` | Specifies the path to the directory containing the project definition. This path is automatically generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | | `$AC_TUIST_VERSION` | Specifies the Tuist version. If not specified, the latest version of Tuist will be installed. | Optional | +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/xcode-select.md b/docs/workflows/ios-specific-workflow-steps/xcode-select.md index f57dcd7be..ffd201e0c 100644 --- a/docs/workflows/ios-specific-workflow-steps/xcode-select.md +++ b/docs/workflows/ios-specific-workflow-steps/xcode-select.md @@ -1,30 +1,36 @@ --- title: Xcode Select -description: Specify Xcode version for your build process with Xcode Select. Always use before CocoaPods Install and Xcodebuild steps. -tags: [xcode, version, workflow, step] +description: Specify Xcode version for your build process with Xcode Select. +tags: [xcode, version, select, workflow, step] --- import Screenshot from '@site/src/components/Screenshot'; # Xcode Select (Version) -This step is used to specify the Xcode version to be used during the build process. All available versions of Xcode can be seen in the [Configuration](https://docs.appcircle.io/build/build-process-management/build-profile-configuration) tab. +This step is used to specify the Xcode version to be used during the build process. All available versions of Xcode can be seen in the [Configuration](/build/build-process-management/build-profile-configuration) tab. ### Prerequisites +There are no prerequisites required before using the **Xcode Select** step. + :::danger -Always use this step **before** [**CocoaPods Install**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/#cocoapods-install) and [**Xcodebuild for Devices**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/#xcodebuild-for-devices-archive--export). If you have other **Xcode related** steps, such as [**Xcodebuild for iOS Simulators**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/#xcodebuild-for-ios-simulator) and [**Xcodebuild for Unit and UI Tests**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps/#xcodebuild-for-unit-and-ui-tests), **don't forget** to use before them. + +Always use this step **before** [**CocoaPods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) and [**Xcodebuild for Devices**](/workflows/ios-specific-workflow-steps/xcodebuild-for-devices). If you have other **Xcode related** steps, such as [**Xcodebuild for iOS Simulators**](/workflows/ios-specific-workflow-steps/xcodebuild-for-ios-simulator) and [**Xcodebuild for Unit and UI Tests**](/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test), **don't forget** to use before them. + ::: :::caution -Please **don't forget** to select the **Xcode version** from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration) first. + +Please **don't forget** to select the **Xcode version** from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration) first. + ::: ### Version Change -- To select an Xcode version, open [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration) in the build profile. +- To select an Xcode version, open [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration) in the build profile. @@ -33,27 +39,31 @@ Please **don't forget** to select the **Xcode version** from [Configuration](htt :::info + Appcircle provides new versions of Xcode (including beta versions) within 24 hours after they are released. + ::: -:::caution -### Pool-Based Xcode Version Selection +:::caution Pool-Based Xcode Version Selection A version other than the Xcode versions on the configuration page should not be entered manually as the Xcode select workflow argument. Because the Xcode versions on the configuration page are the versions installed on runners. Entering an unavailable Xcode version may cause the build to fail. -You can review the documentation for detailed information about the Xcode version selection [here](/self-hosted-appcircle/self-hosted-runner/configure-runner/manage-pools/#pool-based-xcode-version-selection). +You can review the documentation for detailed information about the Xcode version selection [here](/self-hosted-appcircle/self-hosted-runner/configure-runner/manage-pools#select-pool-for-build-profile). + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_XCODE_LIST_DIR` | Specifies the directory with the Xcode versions. Xcode versions are located under the /Volumes directory and selected according to the given version. | Required | +| `$AC_XCODE_LIST_DIR` | Specifies the directory with the Xcode versions. Xcode versions are located under the `/Volumes` directory and selected according to the given version. | Required | | `$AC_XCODE_VERSION` | Specifies the xcode version. This variable comes from Configuration. | Required | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-xcode-select-component diff --git a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-devices.md b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-devices.md index 5726dabb9..ebdeee588 100644 --- a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-devices.md +++ b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-devices.md @@ -11,41 +11,45 @@ import Screenshot from '@site/src/components/Screenshot'; This step builds your application for iOS devices in ARM architecture, which is required for the [**Sharing With Testers**](/testing-distribution/create-or-select-a-distribution-profile) feature or any other means of iOS distribution. :::info + This step is the archive and export step. When the step is completed, the `.ipa` file of the application is generated. + ::: ### Prerequisites -The workflow steps that need to be executed before running this step, along with their respective reasons, are listed in the table below. +Before running the **Xcodebuild for Devices** step, you must complete certain prerequisites, as detailed in the table below: | Require Workflow Step | Description | | ---------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps/#git-clone) | The repository that needs to be built must be fetched from the Git provider. **Xcodebuild for Devices** should be used after this step. | -| [**Cocoapods Install**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#cocoapods-install) | This step installs all pod dependencies for project. **Xcodebuild for Devices** should be used after this step. If you use SPM (Swift Package Manager), it is not necessary to use. | -| [**Xcode Select**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcode-select-version) | In this step, select the Xcode version to build. **Xcodebuild for Devices** should be used after this step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repository that needs to be built must be fetched from the Git provider. **Xcodebuild for Devices** should be used after this step. | +| [**Xcode Select**](/workflows/ios-specific-workflow-steps/xcode-select) | In this step, select the Xcode version to build. **Xcodebuild for Devices** should be used after this step. | +| [**Cocoapods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) | This step installs all pod dependencies for project. **Xcodebuild for Devices** should be used after this step. If you use SPM (Swift Package Manager), it is not necessary to use. | :::danger -This step should always follow steps that may affect Archive and Export, such as Xcode Select and Cocoapods Install. + +This step should always follow steps that may affect Archive and Export, such as **Xcode Select** and **Cocoapods Install**. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | --------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | | `$AC_OUTPUT_DIR_PATH` | This variable specifies the path of the artifacts that will be generated after the build is complete. | Required | -| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in **`Configuration => Build Scheme`**, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). | Required | -| `$AC_ARCHIVE_FLAGS` | Specifies the extra xcodebuild flag. For example: -quiet | | -| `$AC_PROJECT_PATH` | Specifies the project path. For example: `./appcircle.xcodeproj`. If you filled in **`Configuration => Project or Workspace`**, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). | Required | +| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in **`Configuration => Build Scheme`**, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Required | +| `$AC_ARCHIVE_FLAGS` | Specifies the extra xcodebuild flag. For example: `-quiet`. | Optional | +| `$AC_PROJECT_PATH` | Specifies the project path. For example: `./appcircle.xcodeproj`. If you filled in **`Configuration => Project or Workspace`**, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Required | | `$AC_CERTIFICATES` | This variable specifies the path of the certificates to be signed. | Required | | `$AC_BUNDLE_IDENTIFIERS` | This variable holds the Bundle Identifier of the application to be built. | Required | | `$AC_PROVISIONING_PROFILES` | This variable specifies the path of provisioning profiles to be signed. | Required | -| `$AC_CONFIGURATION_NAME` | You can build your project with any configuration you want. Specify the configuration as hard coded. Appcircle will add automatically this configuration to the xcodebuild command. For example; **`Debug`** | Optional | +| `$AC_CONFIGURATION_NAME` | You can build your project with any configuration you want. Specify the configuration as hard coded. Appcircle will add automatically this configuration to the xcodebuild command. For example; **`Debug`**. | Optional | | `$AC_COMPILER_INDEX_STORE_ENABLE` | You can disable indexing during the build for faster build. Default value is `No`. | Optional | | `$AC_METHOD_FOR_EXPORT` | Describes how Xcode should export the archive. Available options are `auto-detect`, `app-store`, `ad-hoc`, `enterprise`, `development`. The default is `auto-detect`. | Optional | | `$AC_TEAMID_FOR_EXPORT` | The Developer Portal team to be use for this export. Defaults to the team used to build the archive. | Optional | @@ -57,32 +61,40 @@ You can find all the parameters required for this step in the table below, with ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | | --------------------------- | --------------------------------------------------------- | -| `$AC_ARCHIVE_PATH` | This is the path created after retrieving the archive. | -| `$AC_ARCHIVE_METADATA_PATH` | This is the path created after the metadata is generated. | -| `$AC_EXPORT_DIR` | This is the path created when exporting. | +| `AC_ARCHIVE_PATH` | This is the path created after retrieving the archive. | +| `AC_ARCHIVE_METADATA_PATH` | This is the path created after the metadata is generated. | +| `AC_EXPORT_DIR` | This is the path created when exporting. | + +--- To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-ios-build-sign-component +--- + ## FAQ ### Adding Additional Command to Xcodebuild for Devices Step -To address the need to add a new command after completing the `xcodebuild` command in the "Xcodebuild for Devices" step, you can follow the following approach: +To address the need to add a new command after completing the `xcodebuild` command in the **Xcodebuild for Devices** step, you can follow the following approach: -- Disable "Xcodebuild for Devices" step in your workflow. -- Add a new "Custom Script" component instead of "Xcodebuild for Devices" step. +- Disable **Xcodebuild for Devices** step in your workflow. +- Add a new "Custom Script" component instead of **Xcodebuild for Devices** step. - Go to Appcircle github profile and navigate to the [repository](https://github.com/appcircleio/appcircle-ios-build-sign-component). -- Copy all code lines from the `main.rb` file and paste them into the new "Custom Script" that you just added in your workflow. -- Change the name as "Custom Xcodebuild for Devices" for this custom script. +- Copy all code lines from the `main.rb` file and paste them into the new **Custom Script** that you just added in your workflow. +- Change the name as **Custom Xcodebuild for Devices** for this custom script. - Change "Execute With" picker as **Ruby**. - In the Ruby code, you can add the required codes to the end of the `xcodebuild` command. :::caution -Before running the script, some variables must be changed, and new variables must be added to the custom script. + +Before running the script, some variables must be changed, and new variables must be added to the **Custom Script**. + ::: First, the `output_path` global variable should be changed like below in global variables. @@ -111,7 +123,9 @@ $compiler_index_store_enable = AC_COMPILER_INDEX_STORE_ENABLE ``` :::caution + You should find the line with `compiler_index_store_enable` and replace it with the above statement. + ::: After these variables were set. There is an `archive()` function in the Ruby code. First, find the function in the code. diff --git a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-ios-simulator.md b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-ios-simulator.md index 818783cc2..462c5390a 100644 --- a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-ios-simulator.md +++ b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-ios-simulator.md @@ -12,47 +12,55 @@ This step builds your application for the iOS Simulator in x86_64 or arm64 archi ### Prerequisites -Use this step after the **Xcode Select** and **CocoaPods Install** (if you use **CocoaPods** in your project) steps. +Before running the **Xcodebuild for iOS Simulator** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcode Select**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcode-select-version) | This step selects the Xcode version that is specified. | -| [**Cocoapods Install**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#cocoapods-install) | This step installs all the dependencies of the pod file. | +| [**Xcode Select**](/workflows/ios-specific-workflow-steps/xcode-select) | This step selects the Xcode version that is specified. | +| [**Cocoapods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) | This step installs all the dependencies of the pod file. | :::caution + If you use SPM (Swift Package Manager), Xcode will manage itself when a project is built. The **CocoaPods Install** step is not necessary. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|--------| -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | | `$AC_OUTPUT_DIR_PATH` | Specifies the path for outputs for generated artifacts. | Required | -| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in `Config => Build Schema` in the Configuration, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). | Required | +| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in `Config => Build Schema` in the Configuration, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Required | | `$AC_SIMULATOR_ARCH` | Specifies the CPU architecture for the simulator build. The default variable is **`arm64`**. | Optional | -| `$AC_SIMULATOR_NAME` | Destination name of the simulator. Ex. `iPhone 14`. If you set a simulator name, the build will be installed into the given simulator. Please be aware that setting the simulator name invalidates the `AC_SIMULATOR_ARCH` option. | Required | -| `$AC_ARCHIVE_FLAGS` | Specifies the extra xcodebuild flag. For example: -quiet | Optional | -| `$AC_PROJECT_PATH` | Specifies the project path. If you filled in `Config => Xcode Project or Workspace Path` in the Configuration, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). For example: `./appcircle.xcodeproj`. | Required | +| `$AC_SIMULATOR_NAME` | Destination name of the simulator. Ex. `iPhone 14`. If you set a simulator name, the build will be installed into the given simulator. Please be aware that setting the simulator name invalidates the `$AC_SIMULATOR_ARCH` option. | Required | +| `$AC_ARCHIVE_FLAGS` | Specifies the extra xcodebuild flag. For example: `-quiet`. | Optional | +| `$AC_PROJECT_PATH` | Specifies the project path. If you filled in `Config => Xcode Project or Workspace Path` in the Configuration, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). For example: `./appcircle.xcodeproj`. | Required | | `$AC_CONFIGURATION_NAME` | You can build your project with any configuration you want. Specify the configuration as hard coded. Appcircle will automatically add this configuration to the xcodebuild command. For example; **`Debug`**. | Optional | | `$AC_COMPILER_INDEX_STORE_ENABLE` | You can disable indexing during the build for a faster build. The default value is **`No`**. | Required | :::caution + Be aware of which OS version you used; the simulator type should match that OS version. For example, if you use the [**latest OS version**](https://developer.apple.com/documentation/ios-ipados-release-notes), you can not use the **iPhone 14** simulator. + ::: ### Output Variables +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |-------------------------------|------------------------------------------------| -| `$AC_SIMULATOR_APP_PATH` | Simulator app path. You can reach the Simulator app from this path, and it will be exported, it can be downloaded from the download artifacts. | +| `AC_SIMULATOR_APP_PATH` | Simulator app path. You can reach the simulator app from this path, and it will be exported, it can be downloaded from the **Download Artifacts**. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-testing.md b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-testing.md index fdb7c2d7a..2d498b852 100644 --- a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-testing.md +++ b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-testing.md @@ -8,51 +8,55 @@ import Screenshot from '@site/src/components/Screenshot'; # Xcodebuild for Testing -This step builds your application and generates an IPA for testing so that it can be used in test automation frameworks like [**BrowserStack**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#browserstack-app-automate---xcui) or [**Testinium**](/workflows/common-workflow-steps/testinium). +This step builds your application and generates an IPA for testing so that it can be used in test automation frameworks like [**BrowserStack**](/workflows/ios-specific-workflow-steps/browserstack-app-automation) or [**Testinium**](/workflows/common-workflow-steps/testinium). ### Prerequisites -In order for this step to work correctly, it must be used after the two steps listed below. +Before running the **Xcodebuild for Testing** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Xcode Select**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#xcode-select-version) | This step selects the Xcode version that is specified. | -| [**CocoaPods Install**](https://docs.appcircle.io/workflows/ios-specific-workflow-steps#cocoapods-install) | This step installs all the dependencies of the pod file. | +| [**Xcode Select**](/workflows/ios-specific-workflow-steps/xcode-select) | This step selects the Xcode version that is specified. | +| [**CocoaPods Install**](/workflows/ios-specific-workflow-steps/cocoapods-install) | This step installs all the dependencies of the pod file. | :::caution + If you use SPM (Swift Package Manager), Xcode will manage itself when a project build. The **CocoaPods Install** step is not necessary. + ::: ### Input Variables -You can find the parameters required for this step to work and detailed explanations in the list below. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|----------------------| -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [Git Clone](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Required | -| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in `Config => Build Schema` in the Configuration, this variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps#git-clone) step. | Required | +| `$AC_SCHEME` | Specifies the project scheme for build. If you filled in `Config => Build Schema` in the Configuration, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Required | | `$AC_ARCHIVE_FLAGS` | Specifies the extra xcodebuild flag. For example: **`-quiet`** | Optional | -| `$AC_PROJECT_PATH` | Specifies the project path. For example: **`./appcircle.xcodeproj`**. This variable comes from [Configuration](https://docs.appcircle.io/build/building-ios-applications#build-configuration). | Required | +| `$AC_PROJECT_PATH` | Specifies the project path. For example: **`./appcircle.xcodeproj`**. This variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Required | | `$AC_CONFIGURATION_NAME` | You can build your project with any configuration you want. Specify the configuration as hard-coded. Appcircle will automatically add this configuration to the xcodebuild command. For example; **`Debug`** | Optional | | `$AC_COMPILER_INDEX_STORE_ENABLE` | You can disable indexing during the build for a faster build. The default value is **`No`**. | Optional | | `$AC_DESTINATION` | This parameter determines for which destination the application will be built and IPA will be generated. The default value is **`generic/platform=iOS`**, which means that it will be built for all iOS devices. | Required | ### Output Variables -This component outputs some important parameters after running. +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | |-------------------------------|------------------------------------------------| -| `$AC_TEST_APP_PATH` | This parameter is the path of the application after the build is complete. If you are using a test automation tool, you can use this path as the app path. | -| `$AC_UITESTS_RUNNER_PATH` | This path is the UI Runner Path for running UI tests after the build is complete. This variable is sent to test automation tools to run the tests. | -| `$AC_XCTEST_PATH` | This variable is the path containing the tests. | -| `$AC_UITESTS_RUNNER_IPA_PATH` | This variable is the path that the IPA generated for the test creates for the UI tests to run. This can be sent directly to test automation tools. | -| `$AC_XCTEST_ZIP_PATH` | Path to the IPA version of the Xctests. You can access it directly via this path. | -| `$AC_TEST_IPA_PATH` | This path holds the IPA file created for running tests and sending the IPA file to test automation tools. | +| `AC_TEST_APP_PATH` | This parameter is the path of the application after the build is complete. If you are using a test automation tool, you can use this path as the app path. | +| `AC_UITESTS_RUNNER_PATH` | This path is the UI Runner Path for running UI tests after the build is complete. This variable is sent to test automation tools to run the tests. | +| `AC_XCTEST_PATH` | This variable is the path containing the tests. | +| `AC_UITESTS_RUNNER_IPA_PATH` | This variable is the path that the IPA generated for the test creates for the UI tests to run. This can be sent directly to test automation tools. | +| `AC_XCTEST_ZIP_PATH` | Path to the IPA version of the Xctests. You can access it directly via this path. | +| `AC_TEST_IPA_PATH` | This path holds the IPA file created for running tests and sending the IPA file to test automation tools. | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test.md b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test.md index ed5c8660e..d9d3e7a79 100644 --- a/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test.md +++ b/docs/workflows/ios-specific-workflow-steps/xcodebuild-for-unit-and-ui-test.md @@ -1,7 +1,7 @@ --- title: Xcodebuild for Unit and UI Testing description: This step performs unit and UI tests for your iOS applications. This does not "build" your app, but uses the "xcodebuild" command to run tests. -tags: [build, test, ios, workflow, step] +tags: [build, test, ios, workflow, xcodebuild, unit, ui, testing] --- import Screenshot from '@site/src/components/Screenshot'; @@ -17,9 +17,12 @@ This step does not generate **IPA**, it only runs tests within the project. ::: ### Prerequisites + +Before running the **Xcodebuild for Unit and UI Testing** step, you must complete certain prerequisites, as detailed in the table below: + | Prerequisite Workflow Step | Description | |-------------------------------------------------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repository must be cloned to initiate the unit and UI testing process. Following the clone, this step will run the tests and create the `AC_REPOSITORY_DIR` variable. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repository must be cloned to initiate the unit and UI testing process. Following the clone, this step will run the tests and create the `$AC_REPOSITORY_DIR` variable. | | [**Xcode Select**](/workflows/ios-specific-workflow-steps/xcode-select) | This step selects the specified Xcode version. | @@ -35,20 +38,20 @@ If any tests fail during this step, an error will be automatically reported, whi ### Input Variables -Below are the parameters required for this step, along with detailed explanations. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [Git Clone](/workflows/common-workflow-steps/git-clone) step. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | | `$AC_OUTPUT_DIR_PATH` | Specifies the path for outputs for generated artifacts. | Required | | `$AC_SCHEME` | Specifies the project scheme for build. If you filled in `Config => Build Schema` in the Configuration, this variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Required | | `$AC_ARCHIVE_FLAGS` | Specifies the extra xcodebuild flag. For example: **`-quiet`** | Optional | | `$AC_PROJECT_PATH` | Specifies the project path. For example: **`./appcircle.xcodeproj`**. This variable comes from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration). | Optional | | `$AC_CONFIGURATION_NAME` | You can build your project with any configuration you want. Specify the configuration as hard-coded. Appcircle will automatically add this configuration to the xcodebuild command. For example; **`Debug`** | Optional | | `$AC_COMPILER_INDEX_STORE_ENABLE`| You can disable indexing during the build for a faster build. The default value is **`No`**. | Required | -| `$AC_TEST_OS_VERSION` | Specify the test OS version. The default value is `latest`. User can use different OS version. For example: `16.3` | Required | +| `$AC_TEST_OS_VERSION` | Specify the test OS version. The default value is `latest`. User can use different OS version. For example: `16.3`. | Required | | `$AC_TEST_DEVICE` | Destination name of the test simulator device. Ex. `iPhone 14`. If you set a simulator name, the build will be installed into the given simulator. The default value is `iPhone 8 Plus`. | Required | | `$AC_TEST_PLATFORM` | Specify the test platform. The default value is `iOS Simulator`. | Required | @@ -60,11 +63,20 @@ Ensure the simulator type matches the OS version used. For example, if you use t :::caution -To view the output artifacts on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your Workflow after this step. +To view the output artifacts on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts#download-exported-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your workflow after this step. ::: ### Output Variables + +The output(s) resulting from the operation of this component are as follows: + | Variable Name | Description | |-------------------------------|----------------------------------------------------------------------------------------------------------| -| `$AC_TEST_RESULT_PATH` | The output path for the `.xcresult` file. This environment variable can be utilized in subsequent steps. | \ No newline at end of file +| `AC_TEST_RESULT_PATH` | The output path for the `.xcresult` file. This environment variable can be utilized in subsequent steps. | + +--- + +To access the source code of this component, please use the following link: + +https://github.com/appcircleio/appcircle-ios-test-component \ No newline at end of file diff --git a/docs/workflows/react-native-specific-workflow-steps/app-center-code-push.md b/docs/workflows/react-native-specific-workflow-steps/app-center-code-push.md index ddd307305..b7df053cb 100644 --- a/docs/workflows/react-native-specific-workflow-steps/app-center-code-push.md +++ b/docs/workflows/react-native-specific-workflow-steps/app-center-code-push.md @@ -18,19 +18,19 @@ Before running the **App Center CodePush** step, you must complete certain prere | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [Git Clone](/workflows/common-workflow-steps/git-clone) | The repository needs to be cloned to begin the CodePush process. After this step, the variable `AC_REPOSITORY_DIR` will be set. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | The repository needs to be cloned to begin the CodePush process. After this step, the variable `$AC_REPOSITORY_DIR` will be set. | ### Input Variables -Below is a list of input variables that can be used with this component with a description of each. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). -:::danger +:::danger Sensitive Variables -Avoid hard-coding sensitive information, like tokens and API keys, directly into the step parameters. +Please do not use sensitive variables such as **Username**, **Password**, **API Key**, or **Personal Access Key** directly within the step. We recommend using [**Environment Variables**](/environment-variables/managing-variables) groups for such sensitive variables. @@ -40,7 +40,7 @@ We recommend using [**Environment Variables**](/environment-variables/managing-v | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|------------------| | `$AC_APPCENTER_TOKEN` | App Center API Token. | Required | -| `$AC_APPCENTER_PRIVATE_KEY` | App Center Private Key to sign updates. Upload your private key (.pem) to environment variables as a file and set its name as `AC_APPCENTER_PRIVATE_KEY`. | Optional | +| `$AC_APPCENTER_PRIVATE_KEY` | App Center Private Key to sign updates. Upload your private key (`.pem`) to environment variables as a file and set its name as `$AC_APPCENTER_PRIVATE_KEY`. | Optional | | `$AC_PROJECT_PATH` | Relative path of the React Native project. Leave it empty to use the parent repository path. | Optional | | `$AC_APPCENTER_OWNER` | Owner of the app. The app's owner can be identified in its URL, such as `https://appcenter.ms/users/JohnDoe/apps/myapp` for a user-owned app (where **JohnDoe** is the owner) and `https://appcenter.ms/orgs/Appcircle/apps/myapp` for an org-owned app (owner is **Appcircle**). | Required | | `$AC_APPCENTER_APPNAME` | The name of the app. The app's name can be identified in its URL, such as `https://appcenter.ms/users/JohnDoe/apps/myapp` for a user-owned app (where **myapp** is the app name) and `https://appcenter.ms/orgs/Appcircle/apps/myapp` for an org-owned app (owner is **myapp**). | Required | @@ -48,13 +48,10 @@ We recommend using [**Environment Variables**](/environment-variables/managing-v | `$AC_APPCENTER_DEPLOYMENT` | This parameter specifies which deployment you want to release the update to. It defaults to `Staging`. | Optional | | `$AC_APPCENTER_ROLLOUT` | This parameter specifies the percentage of users (as an integer between 1 and 100) that should be eligible to receive this update. | Optional | | `$AC_APPCENTER_VERSION` | The latest version will be used if no version is set. | Optional | -| `$AC_APPCENTER_EXTRA` | Extra command line arguments for appcenter. For example, add `--debug` for verbose logs. | Optional | +| `$AC_APPCENTER_EXTRA` | Extra command line arguments for App Center. For example, add `--debug` for verbose logs. | Optional | -### Output Variables - -The **App Center CodePush** step does not produce any output variables. The results are shown in the build log. - +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/react-native-specific-workflow-steps/node-install.md b/docs/workflows/react-native-specific-workflow-steps/node-install.md index 620f00616..c666db82f 100644 --- a/docs/workflows/react-native-specific-workflow-steps/node-install.md +++ b/docs/workflows/react-native-specific-workflow-steps/node-install.md @@ -1,7 +1,7 @@ --- title: Install Node description: Ensure the correct Node version for your React Native app with Install Node. A crucial step for building React Native applications. -tags: [react native, mobile, workflow, step] +tags: [react native, mobile, workflow, step, node, install, version] --- import Screenshot from '@site/src/components/Screenshot'; @@ -11,30 +11,39 @@ import Screenshot from '@site/src/components/Screenshot'; React Native applications commonly depend on certain Node modules. This workflow step makes sure that you have the required Node version installed in the build agent to build your React Native application. ### Prerequisites + +Before running the **Install Node** step, you must complete certain prerequisites, as detailed in the table below: + | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) | Clone the selected repository to the build machine. Please use the [**Install Node**](https://docs.appcircle.io/workflows/react-native-specific-workflow-steps#install-node) step after this step. | +| [**Git Clone**](/workflows/common-workflow-steps/git-clone) | Clone the selected repository to the build machine. Please use the **Install Node** step after this step. | :::caution + Please note that this step should be used before steps that need the **npm/yarn Commands** step. To avoid any problems, you can run this step after the **Git Clone** step. + ::: ### Input Variables -You can find all the parameters required for this step in the table below, with their descriptions in detail. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|--------| -| `$AC_SELECTED_NODE_VERSION` | This step takes only the **node version** variable. You can specify the version directly in the step if you wish. Or you can get it from build [**Configurations**](https://docs.appcircle.io/build/building-react-native-applications#build-configuration-for-react-native-ios-applications). | Optional | +| `$AC_SELECTED_NODE_VERSION` | This step takes only the **Node version** variable. You can specify the version directly in the step if you wish. Or you can get it from build [**Configurations**](/build/platform-build-guides/building-react-native-applications#build-configuration-for-react-native-ios-applications). | Optional | :::caution + If you do not specify any specific version for the **Install Node** step. The latest version will be installed automatically. + ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-node-install-component \ No newline at end of file diff --git a/docs/workflows/react-native-specific-workflow-steps/npm-yarn-commands.md b/docs/workflows/react-native-specific-workflow-steps/npm-yarn-commands.md index e90754aab..f5c53e3f6 100644 --- a/docs/workflows/react-native-specific-workflow-steps/npm-yarn-commands.md +++ b/docs/workflows/react-native-specific-workflow-steps/npm-yarn-commands.md @@ -1,7 +1,7 @@ --- title: NPM/Yarn Commands description: Learn to use NPM/Yarn commands for managing dependencies in your React Native applications. Enhance your app's functionality. -tags: [react native, mobile, workflow, step] +tags: [react native, mobile, workflow, step, npm, yarn, commands] --- import Screenshot from '@site/src/components/Screenshot'; @@ -12,24 +12,26 @@ You may want to use the [NPM](https://www.npmjs.com/) or [Yarn](https://www.npmj ### Prerequisites -The workflow steps that need to be executed before running the **NPM/Yarn Commands** workflow step, along with their respective reasons, are listed in the table below. +Before running the **NPM/Yarn Commands** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |-------------------------------------------------|-------------------------------------------------| -| [**Install Node**](https://docs.appcircle.io/workflows/react-native-specific-workflow-steps#install-node) | This step will install Node modules for your application. Please note that the **NPM/Yarn Commands** step should be used after this step. | +| [**Install Node**](/workflows/react-native-specific-workflow-steps/node-install) | This step will install Node modules for your application. Please note that the **NPM/Yarn Commands** step should be used after this step. | ### Input Variables -This step contains different variables. It needs these variables to work. The table below gives explanations of these variables. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |-------------------------------|------------------------------------------------|--------| -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Required | -| `$AC_NPM_COMMAND_ARGS` | The NPM command to run. You can add different command parameters directly. The default is: `npm/yarn install` | Optional | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps/git-clone) step. | Required | +| `$AC_NPM_COMMAND_ARGS` | The NPM command to run. You can add different command parameters directly. The default is: `npm/yarn install`. | Optional | + +--- To access the source code of this component, please use the following link: diff --git a/docs/workflows/react-native-specific-workflow-steps/react-native-ui-test.md b/docs/workflows/react-native-specific-workflow-steps/react-native-ui-test.md index faa971e57..2b0207030 100644 --- a/docs/workflows/react-native-specific-workflow-steps/react-native-ui-test.md +++ b/docs/workflows/react-native-specific-workflow-steps/react-native-ui-test.md @@ -22,7 +22,7 @@ The default Java version in Appcircle's build stacks is **Java 17**. If your pro ### Prerequisites -The workflow steps that need to be executed before running the **React Native UI Test** workflow step in both iOS and Android platforms, along with their respective reasons, are listed in the table below. +Before running the **React Native UI Test** step, you must complete certain prerequisites, as detailed in the table below: #### For iOS @@ -77,13 +77,13 @@ If any workflow steps fail, Appcircle automatically skips the next steps. Howeve ### Input Variables -This step contains different variables. It needs these variables to work. The table below gives explanations of these variables. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps#git-clone) step. | Required | | `$AC_OUTPUT_DIR` | This variable specifies the path of the artifacts that will be generated after the build is complete. | Required | | `$AC_RN_DETOX_CONFIGURATION` | Specify the detox configuration name to used when building and running the tests. | Required | | `$AC_RN_DETOX_TEST_ARGS` | Specify the Detox extra arguments to add the test command. The arguments will be executed by appending `detox test --configuration` to the end of the command. The default value is `--take-screenshots all` For more information, see the Detox test [CLI options](https://wix.github.io/Detox/docs/19.x/api/detox-cli/#test). | Optional | @@ -141,6 +141,8 @@ The outputs resulting from the operation of this component are as follows: | --------------------- | ------------------------------------------------------------------------------------------------------------ | | `AC_TEST_RESULT_PATH` | The output path for the `e2e-report.xml` file. This environment variable can be utilized in subsequent steps. | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-react-native-ui-test-component diff --git a/docs/workflows/react-native-specific-workflow-steps/react-native-unit-test.md b/docs/workflows/react-native-specific-workflow-steps/react-native-unit-test.md index 0e4dd05e3..3c2d563f9 100644 --- a/docs/workflows/react-native-specific-workflow-steps/react-native-unit-test.md +++ b/docs/workflows/react-native-specific-workflow-steps/react-native-unit-test.md @@ -14,7 +14,7 @@ For detailed information for continuous testing, please visit our [React Native ### Prerequisites -The workflow steps that need to be executed before running the **React Native Unit Test** workflow step, along with their respective reasons, are listed in the table below. +Before running the **React Native Unit Test** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | |--------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -36,25 +36,25 @@ If any workflow steps fail, Appcircle automatically skips the next steps. Howeve ### Input Variables -This step contains different variables. It needs these variables to work. The table below gives explanations of these variables. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | |----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------| -| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](https://docs.appcircle.io/workflows/common-workflow-steps#git-clone) step. | Required | +| `$AC_REPOSITORY_DIR` | Specifies the cloned repository directory. This path will be generated after the [**Git Clone**](/workflows/common-workflow-steps#git-clone) step. | Required | | `$AC_OUTPUT_DIR` | This variable specifies the path of the artifacts that will be generated after the build is complete. | Required | | `$AC_RN_TEST_COMMAND_ARGS` | Specify additional command arguments for running Jest tests. An extra parameter will be added to the end of the command `jest`. You can add extra arguments, such as `--debug --colors`, without affecting the default ones. For more information, see the Jest [CLI options](https://jestjs.io/docs/cli#options). | Optional | :::caution -To view the output artifacts on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your Workflow after this step. +To view the output artifacts on the [**Download Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) page, please ensure that the [**Export Build Artifacts**](/workflows/common-workflow-steps/export-build-artifacts) step is included in your workflow after this step. ::: ### Output Variables -The outputs resulting from the operation of this component are as follows: +The output(s) resulting from the operation of this component are as follows: | Variable Name | Description | |-----------------------|-----------------------------------------------------------------------------------------------------------------| @@ -66,6 +66,8 @@ Appcircle does **not** currently support **test coverage** calculation for React ::: +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-react-native-unit-test-component diff --git a/docs/workflows/react-native-specific-workflow-steps/test-reports-react-native.md b/docs/workflows/react-native-specific-workflow-steps/test-reports-react-native.md index 516a7f06d..43809e970 100644 --- a/docs/workflows/react-native-specific-workflow-steps/test-reports-react-native.md +++ b/docs/workflows/react-native-specific-workflow-steps/test-reports-react-native.md @@ -18,7 +18,7 @@ For additional details, please refer to the document: [**Generating Test Report* ### Prerequisites -Before executing the **Test Report** workflow step, **one of the** following steps must be run to generate the report: +Before running the **Test Reports for React Native** step, you must complete certain prerequisites, as detailed in the table below: | Prerequisite Workflow Step | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | @@ -33,7 +33,7 @@ To able to use the **Test Report** component, not necessary to use both test ste ### Input Variables -For each component, specific input variables are required for its operation on your system. +This step contains some input variable(s). It needs these variable(s) to work. The table below gives explanation for this variable(s). | Variable Name | Description | Status | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------- | @@ -54,6 +54,8 @@ The outputs resulting from the operation of this component are as follows: | -------------------------- | -------------------------------------- | | `AC_TEST_REPORT_JSON_PATH` | Specifies the path of the JSON report. | +--- + To access the source code of this component, please use the following link: https://github.com/appcircleio/appcircle-test-report-component