diff --git a/docs/account/my-organization/profile-and-team/role-management.md b/docs/account/my-organization/profile-and-team/role-management.md index 578735740..087c5b323 100644 --- a/docs/account/my-organization/profile-and-team/role-management.md +++ b/docs/account/my-organization/profile-and-team/role-management.md @@ -95,7 +95,7 @@ The following table details the roles and restrictions for the [**Environment Va :::info -**Manager**, **Operator** and **Viewer** Environment Variable permissions can use variable groups in [**Build profile configuration**](/build/build-process-management/build-profile-configuration#environment-variables-configuration). +**Manager**, **Operator** and **Viewer** Environment Variable permissions can use variable groups in [**Build profile configuration**](/build/build-environment-variables). ::: @@ -127,7 +127,7 @@ The following table details the roles and restrictions for the [**Signing and Id :::info Signing and Identities -**Manager** and **Viewer** Signing Identity permissions can use signing identities in [**Build profile configuration**](/build/build-process-management/build-profile-configuration#environment-variables-configuration). +**Manager** and **Viewer** Signing Identity permissions can use signing identities in [**Build profile configuration**](/build/build-process-management/configurations#environment-variables-configuration). ::: diff --git a/docs/build/build-environment-variables/_category_.json b/docs/build/build-environment-variables/_category_.json new file mode 100644 index 000000000..793e75ad9 --- /dev/null +++ b/docs/build/build-environment-variables/_category_.json @@ -0,0 +1,6 @@ +{ + "label": "Environment Variables", + "position": 2, + "collapsed": true, + "collapsible": true +} diff --git a/docs/environment-variables/managing-variables.md b/docs/build/build-environment-variables/index.md similarity index 92% rename from docs/environment-variables/managing-variables.md rename to docs/build/build-environment-variables/index.md index 540403238..62b0eb690 100644 --- a/docs/environment-variables/managing-variables.md +++ b/docs/build/build-environment-variables/index.md @@ -52,11 +52,11 @@ When you upload a file as an environment variable, file name is not preserved. T ::: -### Download Environment Variables +### Downloading environment variables You can download and view environment variables in **JSON** format. For this, you can use the "Download" button by clicking on the three dots next to one of the variable groups under "Build > Environment Variables > Variable Groups". -In the downloaded file content, you will see a structure as **key-value** pairs. +In the downloaded file content, you will see a structure with **key-value** pairs. Here you can view text and file-based variables. However, only the name of the environment variables you added as a file will appear. The related file will not be downloaded. @@ -103,7 +103,7 @@ As seen in the example above; ::: -### Using environment variable groups in builds +#### Using environment variable groups in builds Environment variable groups can be used in builds to extend the workflow and add additional actions to workflow steps. @@ -115,7 +115,7 @@ Then in workflows, you can specify the environment variable for use. -### Creating environment variables on the fly +#### Creating environment variables on the fly If you want to create environment variables on the fly, you should write those environment variables to a special file called `AC_ENV_FILE_PATH`. For example, if we want to create a build number based on a timestamp and use it in the next steps we can use the following custom script. @@ -125,7 +125,7 @@ If you want to create environment variables on the fly, you should write those e Any step after this custom script can access the `$BUILD_NUMBER` environment variable. -### Using Environment Variables For SSH And PAT (Personal Access Token) Connections of the Git Provider +#### Using Environment Variables For SSH And PAT (Personal Access Token) Connections of the Git Provider You can use personal access tokens or SSH private keys from the environment variables according to your needs by defining them once. @@ -169,3 +169,5 @@ If your SSH public key is not defined on the Git provider, Appcircle will not be ::: Connecting to Repository via SSH + +For platform specific environment variables and more detailed information, please refer to the related [documentation](/environment-variables/platform-specific-usage). \ No newline at end of file diff --git a/docs/build/build-history.md b/docs/build/build-history.md index a4df8a9dc..897b25c53 100644 --- a/docs/build/build-history.md +++ b/docs/build/build-history.md @@ -8,11 +8,11 @@ tags: [reports, build history, build sessions, testing] This report is accessible from the Build module. -Build History Report contains the list of build sessions initiated in a given time period. +The Build History Report contains the list of build sessions initiated in a given time period. Each build session is defined as an initiated manual or automatic build for a commit under a branch of a build profile. -The duration indicates the minutes spent by the build agent for the specified build operation. This value only includes the actual duration that the agent was active, including the agent boot duration but excluding the queue wait duration.; +The duration indicates the minutes spent by the build agent for the specified build operation. This value only includes the actual duration that the agent was active, including the agent boot duration but excluding the queue wait duration. The date and time are displayed in the current timezone. @@ -22,4 +22,4 @@ You can filter the report pages according to the organization. In the filtering options, you can only view and select the organization and sub-organization you belong to. ::: - + \ No newline at end of file diff --git a/docs/build/build-process-management/_category_.json b/docs/build/build-process-management/_category_.json index 038aa7a4e..9ac706f8d 100644 --- a/docs/build/build-process-management/_category_.json +++ b/docs/build/build-process-management/_category_.json @@ -1,6 +1,6 @@ { - "label": "Build Profile Management", - "position": 2, + "label": "Build Profile", + "position": 1, "collapsed": true, "collapsible": true } diff --git a/docs/build/post-build-operations/after-a-build.md b/docs/build/build-process-management/binary-actions.md similarity index 68% rename from docs/build/post-build-operations/after-a-build.md rename to docs/build/build-process-management/binary-actions.md index 47b8b0adf..68a08484e 100644 --- a/docs/build/post-build-operations/after-a-build.md +++ b/docs/build/build-process-management/binary-actions.md @@ -1,22 +1,19 @@ --- -title: Build Actions -description: Learn how to manage build artifacts in Appcircle -tags: [build, build artifacts, build outputs, build logs, faq] -sidebar_position: 13 +title: Binary Actions +description: Learn how to use binary actions on Appcircle +tags: [build, binary actions] +sidebar_position: 7 --- -import Screenshot from '@site/src/components/Screenshot'; -import ContentRef from '@site/src/components/ContentRef'; +# Binary Actions -# Build Actions +With Appcircle's post-build actions, you can easily distribute your binary file manually, access artifacts, and examine build logs. -With Appcircle's post-build actions, you can easily distribute your binary file manually, access artifacts and examine build logs. + - +## Distribute Binary -### Distribute Binary - -The Distribute Binary feature sends the binary file to the relevant module based on the Distribution settings in the selected configuration. +The Distribute Binary feature sends the binary file to the relevant module based on the distribution settings in the selected configuration. :::caution @@ -24,37 +21,41 @@ Please note that AAB files will not be distributed automatically since they cann ::: -### View Build Logs + + +## View Build Logs This feature allows the relevant build logs to be reviewed in the Appcircle log window. The logs can be examined step by step separately. -### Download Artifacts + + +## Download Artifacts Each time a build is completed by Appcircle, all artifacts produced after the build are stored for easy access. These files, which include artifacts such as IPA, APK, and AAB binary files, log files, and archive files, can be accessed by selecting Download Artifacts. :::caution Output Artifacts -### For Android +#### For Android -If your Android application has multiple product flavors, Appcircle will create a build for each flavor of your application and let you distribute them at once. A common usage to multi-flavor applications can be free and paid versions of the same application. +If your Android application has multiple product flavors, Appcircle will create a build for each flavor of your application and let you distribute them at once. A common usage of multi-flavor applications can be free and paid versions of the same application. When you build and distribute an application with multiple flavors, and `.apk` file will be created for each flavor. On our [**testing portal**](/testing-distribution/testing-portal), your testers will be able to download each `.apk` file separately and test it on their devices. -### For iOS +#### For iOS iOS applications can be downloaded or distributed as IPA file format if you configure signing identities and sign the application during the build process. -If you disable signing or don't use any signing identities, iOS output will be an `.xarchive` file. +If you disable signing or don't use any signing identities, iOS output will be a `.xarchive` file. ::: -### Download Build Logs +## Download Build Logs In addition to allowing the review of logs, Appcircle also permits the downloading of these logs in .txt file format, enabling the logs to be downloaded and used in a single file. -### Working with build logs +#### Working with build logs -Build logs help you to observe and understand exactly what happened during a build. You can see build logs as they happen while a build is in process or you can view logs of a build after the build is completed. +Build logs help you to observe and understand exactly what happened during a build. You can see build logs as they happen while a build is in process, or you can view logs of a build after the build is completed. :::info @@ -70,17 +71,17 @@ You can use build logs to debug your builds in case you get any errors. Addition You can also download build logs in plain text format in case you would like to investigate them on your own or share with your team. -### Delete Specific Builds +#### Delete Specific Builds -If you want to free up space from your Artifact Storage, you can delete older build profiles which are cluttering your space. +If you want to free up space from your Artifact Storage, you can delete older build profiles that are cluttering your space. -To do that, simply navigate to the Builds tab and select the builds, then click on the Delete icon +To do that, simply navigate to the Builds tab and select the builds, then click on the Delete icon. - + :::info -Build Deletion feature is only available for organizations with Enterprise license. +The build deletion feature is only available for organizations with an enterprise license. ::: @@ -90,15 +91,13 @@ Build Deletion feature is only available for organizations with Enterprise licen Older builds and/or testing distributions will use almost all of your storage. If your artifact storage is full, you can free up some of the old artifacts. -#### [Refer here to delete a build profile](/build/manage-the-connections/adding-a-build-profile#delete-a-build-profile) - -#### [Refer here to delete specific builds from your build profile](/build/post-build-operations/after-a-build#delete-specific-builds) +#### [Refer here to delete specific builds from your build profile](/build/build-process-management/binary-actions#delete-specific-builds) #### [Refer here to delete testing distribution profiles and specific distribution artifacts](/testing-distribution/create-or-select-a-distribution-profile#delete-a-distribution-profile) #### [Refer here to delete a Publish Profile](/publish-module/creating-publish-profiles/managing-publish-profiles#delete-publish-profile) -In order for storage to be freed up, you should also remove the other references pointing to the artifact. In example, if you have built an app, distributed it to testers, and submitted it to the Store Submit, you should delete that build from Testing Distribution, Store Submit, and Builds respectively. +In order for storage to be freed up, you should also remove the other references pointing to the artifact. For example, if you have built an app, distributed it to testers, and submitted it to the Store Submit, you should delete that build from Testing Distribution, Store Submit, and Builds, respectively. :::caution @@ -108,4 +107,4 @@ It may take a couple of minutes to see the change in your account after you have import NeedHelp from '@site/docs/\_need-help.mdx'; - + \ No newline at end of file diff --git a/docs/build/build-process-management/build-manually-or-with-triggers.md b/docs/build/build-process-management/build-manually-or-with-triggers.md index bf6ae4173..1adda0418 100644 --- a/docs/build/build-process-management/build-manually-or-with-triggers.md +++ b/docs/build/build-process-management/build-manually-or-with-triggers.md @@ -1,29 +1,31 @@ --- -title: Manual and Automatic Builds +title: Triggers description: Learn how to build manually or automatically with webhooks and triggers in Appcircle tags: [build, build process management, manual build, automatic build, triggers, webhooks] -sidebar_position: 10 +sidebar_position: 5 --- import Screenshot from '@site/src/components/Screenshot'; -# Build Manually or Automatically with Webhooks and Triggers - There are multiple ways to trigger a build in Appcircle. You can run builds manually or automate the build process with various triggers. -## Manual Build +## Triggers for Manual Builds -As the name states, your build profile will not build your application until you tell it to. You can browse branches in your Git repository and select any commit from any branch you need to build. To initiate a manual build, just press the **Start Build** button. +For the manual builds, the currently available push triggers apply, and if no trigger is configured, the following trigger is provided by default under the [push triggers](#auto-build-on-every-push). If there are others, they may take precedence based on the [trigger priorities](#trigger-priorities). - + -### Workflows for Manual Builds +## Triggers Configuration -For the manual builds, the currently available push triggers apply and if no trigger is configured, the following trigger is provided by default under the [push triggers](#auto-build-on-every-push). If there are others, they may take precedence based on the [trigger priorities](#trigger-priorities). +To set up or manage the build triggers, click the Triggers button in the context menu of the build profile, accessible from the top of the profile details. - + + +The triggers are set up at the profile level, and you can specify individual branch names or [utilize wildcards](/build/build-process-management/build-manually-or-with-triggers#wildcard-reference) for branch names to trigger builds. + +You also need to select a workflow for each trigger, and the build will be run with that trigger for the specified branch. You can build the same branch with different workflows (e.g., production or development), or you can use the same workflow for multiple branches (e.g., multiple feature branches built with the develop workflow). ## Automatic Build @@ -34,8 +36,8 @@ Builds can be triggered with various triggers such as every push to the reposito There are two options to set up webhooks for automatic builds: -- You can [authorize the Appcircle app](/build/manage-the-connections/adding-a-build-profile#connect-your-repository) for GitHub, Bitbucket, or GitLab repositories for direct integration. The triggers will be available for use immediately. (You can skip the next part about the webhook setup.) -- For the repository connections through SSH, you can add the specific webhook for that build profile manually to the compatible git provider. This enables the git provider to send a POST request to Appcircle for the selected events, which you can then use for triggers. +- You can [authorize the Appcircle app](/build/manage-the-connections/adding-a-build-profile) for GitHub, Bitbucket, or GitLab repositories for direct integration. The triggers will be available for use immediately. (You can skip the next part about the webhook setup.) +- For the repository connections through SSH, you can add the specific webhook for that build profile manually to the compatible git provider. This enables the Git provider to send a POST request to Appcircle for the selected events, which you can then use for triggers. ### Setting Up Manual Webhooks for SSH and Public Repositories @@ -43,9 +45,9 @@ For repositories connected through SSH, you can set up triggers with webhooks in When you connect a repository through SSH or through a public URL, the Webhook URL option will be enabled in the context menu of the build profile, accessible from the top of the profile details. - + -If the git provider is detected, a compatible URL will be displayed automatically. If not, you will be first prompted to select the provider to display the webhook URL. +If the Git provider is detected, a compatible URL will be displayed automatically. If not, you will be first prompted to select the provider to display the webhook URL. You can copy this URL and paste it in the related section in the git provider repository settings with the copy button. @@ -73,21 +75,15 @@ You can also use[ appcircle-cli](/appcircle-api-and-cli) to trigger your builds To set up or manage the build triggers, click the Triggers button in the context menu of the build profile, accessible from the top of the profile details. - - -The triggers are set up at the profile level and you can specify individual branch names or [utilize wildcards](#wildcard-reference) for branch names to trigger builds. - -You also need to select a workflow for each trigger and the build will be run with that trigger for the specified branch. You can build the same branch with different workflows (e.g. production or development) or you can use the same workflow for multiple branches (e.g. multiple feature branches built with the develop workflow). - -#### Auto build on every push +### Auto build on every push Appcircle will start building your application whenever you push a commit to your Git repository. For the specified branches, your project will be built automatically with the selected workflow. -You must choose both workflow and a configuration when you're setting up a trigger. +You must choose both workflow, and a configuration when you're setting up a trigger. -#### Auto build pull/merge requests +### Auto build pull/merge requests Appcircle will start building your application whenever you initiate a pull request or merge request from the source branch(es) to the target branch. @@ -100,27 +96,30 @@ Make sure that the names of the source branch and the target branch are spelled :::info + If spaces are used in the name, Appcircle will trim it without spaces. + ::: :::info + If you are using Azure DevOps Server or Azure DevOps Services Cloud as a Git provider, the Appcircle build trigger will not run for PR status updates (Approve, Approve with suggestions, Wait for author, Reject, etc.) or action changes (Complete, Mark as draft, Abandon). Appcircle will only run the trigger for PR creation or PR updates. ::: -#### Triggering different workflows at the same time +### Triggering different workflows at the same time Now you will be able to trigger different workflows in the same source branch and target branch on Appcircle at once. As soon as the trigger is triggered, Appcircle will start running all the triggered triggers in the build queue, starting from the first place in the established trigger queue. -#### Selective auto build with specific tags +### Selective auto build with specific tags -Appcircle will start building your application with the selected workflow whenever you perform a push with certain tags to your Git repository. Your project will be built automatically only if the push has the tags you specify or you can specify a wildcard tag to build all tagged pushes. +Appcircle will start building your application with the selected workflow whenever you perform a push with certain tags to your Git repository. Your project will be built automatically only if the push has the tags you specify, or you can specify a wildcard tag to build all tagged pushes. -This allows build scenarios like building only specific pushes that has the "release" in the tag. +This allows building scenarios like building only specific pushes that have the "release" in the tag. @@ -130,7 +129,7 @@ If your commit message includes `[skip ci]` or `[ci skip]`, your workflow will b ### Retrying a workflow -If your Merge Request comment includes `[retry]`, your workflow will be retried. +If your merge request comment includes `[retry]`, your workflow will be retried. ## Further Automatic Build Subjects @@ -138,7 +137,7 @@ If your Merge Request comment includes `[retry]`, your workflow will be retried. If you set multiple triggers, certain branch definitions will not take precedence over wildcard definitions. They will all start at the same time. Below is an example: -Assume that you have a branch named `development` with three push triggers +Assume that you have a branch named `development` with three push triggers. - Trigger branch: `*` -> Trigger Workflow: Workflow 1 - Trigger branch: `development` -> Trigger Workflow: Workflow 2 @@ -147,7 +146,9 @@ Assume that you have a branch named `development` with three push triggers When there is a push or PR for the development branch, all triggers (since the word `development` contains both `*` and `develop*`) will be used to start a different build for each branch. At this point, a total of three build pipelines will begin. :::info + If multiple triggered builds exceed your plan's concurrency limits, Appcircle will automatically queue them, and all of them will be executed unless you cancel. + ::: ### Wildcard Reference @@ -162,6 +163,41 @@ You can specify branch names or tags with an asterisk wildcard to automate build | `fix-*-build` | Build if it starts with `fix-` and ends with `-build` | | `*` | Build everything | +## FAQ + +### Why is my Appcircle trigger not working and how can I fix it? + +First, ensure that the build profile triggers are set for the desired branches and actions. Please check the trigger settings from the [**Managing Triggers for Builds**](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) section in the documentation. + +Appcircle is triggered via the Git provider's webhooks. To properly work with triggers, webhooks in the repositories are used by Appcircle. Also, ensure that the repository has webhook access to Appcircle. To connect webhooks, the Git provider connection must be set up properly while creating a build profile. + +Certain Git actions to the repositories, such as push, merge, pull request, tag push, etc., activate a specified event with the repository's webhooks. It is necessary to ensure that the desired event is actually triggered by the action in the Git provider's repository. + +If webhooks are disabled due to frequent use or connection-based errors, using test events may help re-enable webhooks in Git providers. + +To ensure webhooks are set and working, the webhook history can be reviewed within the Git providers. Let's check the Git providers below. You can follow the steps in the Git provider's documentation to access the webhook event history. + +- [**GitHub Webhook Deliveries**](https://docs.github.com/en/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries#about-webhook-deliveries) +- [**GitLab Webhook Request History**](https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#view-webhook-request-history) +- [**Azure DevOps Services Webhook History**](https://learn.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops) +- [**Bitbucket Webhook Documentations**](https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks) + +:::info Bitbucket Webhook Event History + +A document detailing the history of webhooks is not provided by Bitbucket. To access the webhook history, please navigate to: + +**Bitbucket -> Repository -> Repository Settings -> Webhooks -> View Requests** + +View Requests has to be enabled before requests can be seen. + +::: + +Once the webhook is created and confirmed to be properly set up and healthy in the Appcircle build profile, and it is verified to work correctly with the specific Git provider, the process works as follows: + +- A Git action, such as pushing a code block, triggers a webhook event. +- This webhook event activates the trigger in Appcircle. +- Appcircle then automatically starts the build process. + ### How to enable triggers for AWS CodeCommit repositories? Appcircle supports AWS CodeCommit triggers through an Amazon SNS topic. diff --git a/docs/build/build-process-management/build-profile-branch-operations.md b/docs/build/build-process-management/build-profile-branch-operations.md index ed7c34010..1caec5dbd 100644 --- a/docs/build/build-process-management/build-profile-branch-operations.md +++ b/docs/build/build-process-management/build-profile-branch-operations.md @@ -1,13 +1,13 @@ --- -title: Branch Management +title: Branch Operations description: Learn how to manage branches in Appcircle tags: [build, build profile, branch management] -sidebar_position: 3 +sidebar_position: 2 --- import Screenshot from '@site/src/components/Screenshot'; -# Build Profile Branch Management +# Build Profile Branch Operations When you connect to a repository, all branches of that repository will be displayed with the last 100 commits. Appcircle provides a number of features for easy management of branches. @@ -36,14 +36,20 @@ The available filter options are: ### Pinning Branches to the Top for Faster Access -If you are using a branch frequently such as develop or master, you can pin it to the top. To pin a branch, click on pin icon next to the branch name. +If you are using a branch frequently, such as develop or master, you can pin it to the top. To pin a branch, click on the pin icon next to the branch name. -The branch will be moved to the top with a pinned indicator. You can unpin the branch by pressing pin button again. +The branch will be moved to the top with a pinned indicator. You can unpin the branch by pressing the pin button again. +### Manually Fetching Branch and Commits + +By clicking the refresh button next to the Branch List title, you can manually start a fetching process that will update your commits and branches from the remote repository. + + + import NeedHelp from '@site/docs/\_need-help.mdx'; diff --git a/docs/build/build-process-management/build-profile-configuration.md b/docs/build/build-process-management/build-profile-configuration.md deleted file mode 100644 index 7a13b6c5e..000000000 --- a/docs/build/build-process-management/build-profile-configuration.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: Profile Configuration -description: Configuring a build profile has some basic steps that need to be completed before starting a build. -tags: [build profile, configuration, build configuration, build profile configuration] -sidebar_position: 2 ---- - -import Screenshot from '@site/src/components/Screenshot'; -import ContentRef from '@site/src/components/ContentRef'; - -# Build Profile Configuration Overview - -Configuring a build profile has some basic steps that need to be completed before starting a build. - -### Creating a configuration - -You may create **Distribution** configuration to send your app to public stores or create **Testing** configuration to send your app to testers. Configurations allow you to set different certificates, distribution channels that can be used with different workflows. - -- Click on **Configurations** to create configurations for different scenarios. - - - -- Click on **New** button to create your first configuration. - - - -- You may change the name of the configuration or delete the ones you don't need. To do that, click on the edit button shown and three dot on the configuration you want to edit/delete. - - - -### Clone Configuration - -If you have a configuration that you use constantly or want to quickly copy a configuration, you can use the "Configuration Clone" feature. - -The configuration clone feature will speed up your projects where you use many configurations. - -First of all, we open the configuration process by clicking the edit button. - - - -Then click on the three dots next to the configuration we want to copy, and click on the "Clone" button in the mini window that opens. - - - -And another one is created identical to the configuration we want to clone. - - - -:::info -The naming here is created by adding "\_copy_1" to the end of the main configuration name. For each configuration to be copied from now on, the name will be incremented to be unique. -::: - -:::tip -Although the system gives a unique name for the copied configuration by default, you can give this configuration a new name using "Rename". -::: - -### Download Configuration - -You can download your **Configuration** in YAML format to perform actions like sharing the settings you've configured or creating a duplicate on another **Build Profile** page. Follow these steps to download your **Configuration**: - -- Open the **Configuration** you've created. -- Locate the download button positioned at the bottom left of the Configuration interface. Click on the download button. - - - -Your _configuration.yaml_ file will be downloaded to your local system. - -:::tip -If you intend to copy the configuration to use on the same **Build Profile** page, consider using the [**Clone Configuration**](#clone-configuration) step as a quicker alternative. -::: - -### Project details configuration - -Every build profile needs to know project details regardless of the project being iOS or Android project. Project details can be entered manually or can be fetched from your project automatically by Appcircle if you click on **Autofill** button. - -You can also select your self-hosted runner from the **SELECT A POOL** dropdown. - - - Self-hosted Runners - - - - -#### Build Priority - -The build priority configuration feature includes three levels: Low, Medium, and High. - -These priority levels influence the starting order of queued builds, ensuring that higher-priority builds are initiated first. - -For instance, if a high-priority build is added to the queue after a low-priority build, the high-priority build will commence before the low-priority one. - -This functionality allows for better management of build processes, enabling teams to prioritize critical updates and enhancements efficiently. - - - -:::info -This feature is only available for organizations with Enterprise license. -::: - -### Signing configuration - -Both iOS and Android applications need to be digitally signed by their developers in order to be able to be installed on real devices or submitted to app stores. - -iOS certificates and Android keystores can be generated within Appcircle or pre-obtained certificates can be uploaded. iOS provisioning profiles need to be obtained from Apple Developer account and uploaded to Appcircle. - - - -### Distribution configuration - -Distribution is a critical step when it comes to testing your app on real devices. You may need multiple testers and testing groups to download, install, test your app, and make sure it works on different devices and operating system versions. - -Distribution configuration allows you to set which testing groups will receive your application after the build is complete. You can manually submit your binary to testers, or Appcircle can do it for you. - -In this window, you can select one or more of the previously created distribution profiles or create a new one. You can use the "Manage Distribution Profiles" button above to quickly manage distribution profiles. - -Finally, check "Automatically Distribute to Testers" if you want your build to be automatically distributed to the selected testers or testing groups. - - - -You can also use other toggles on there to automatically distribute your app to the Enterprise App Store or Store Submit modules. - -#### Send to Enterprise App Store - -- Navigate to the configuration, then go to the Distribution tab, and ensure that **Automatically Distribute to Enterprise App Store** is enabled. - - - -- Whenever a new **signed** build is created, it will be sent to the Enterprise App Store. -- APK or IPA files can also be manually sent by clicking the **...** button and selecting Distribute Binary. - - - -### Environment variables configuration - -You can define variables and secrets to be incorporated during the build in the Environment Variables submodule so that you don't need to store certain keys and configurations within the repository. - - - -### Versioning configuration - -You can set custom rules to manage the versioning of your app. You can increase both the build number and version number according to the rules you set. - - - -### Workflows and Triggers - -For advanced configuration, you can utilize [workflows](/workflows) and for automatic builds, you can utilize [triggers](build-manually-or-with-triggers#automatic-build). - -These options are available at the profile level in the profile context menu. - - - -### Connection Settings - -After connecting build profile to a Git provider, we can see the **"Connection Settings"** button in the build profile details. - - - -You can click on the "Connection Settings" button under the build profile name and URL to see the detailed information about the connection. (PAT, oAuth) - -#### OAuth - - - -#### Personal Access Token (PAT) - - - -:::caution -If you added your repository via **multiple instances** using PAT (Personal Access Token), the "Connection Settings" will look different. - -You can review the [**Connecting Multiple Instances**](/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance#connection-settings-for-multiple-instances) page for using "Connection Settings" on multiple instances. -::: - -import NeedHelp from '@site/docs/\_need-help.mdx'; - - diff --git a/docs/build/build-process-management/build-workflows.md b/docs/build/build-process-management/build-workflows.md new file mode 100644 index 000000000..a51891ba4 --- /dev/null +++ b/docs/build/build-process-management/build-workflows.md @@ -0,0 +1,112 @@ +--- +title: Workflows +description: Learn how to create and manage Build Profile workflows on Appcircle +tags: [build, build profile, workflows] +sidebar_position: 4 +--- + +A workflow is a ladder of steps taken to build your applications. + +Each step has a different purpose, and the workflow can be customized by modifying step parameters and inputs, running custom scripts, or reordering steps. + +Workflows allow you to have complete control over your build process and enhance it with third-party services and features. + +:::caution + +Please note that modifying workflow steps may cause your builds to fail, so utmost care is recommended when editing workflows. + +::: + +### Setting Up Workflows + +To access the workflow editor for a build profile, click the Workflows button in the context menu of the build profile, accessible from the top of the profile details. + + + +The workflow list will be displayed. To view the workflow steps of a workflow, click on it from the workflow list. + + + +To create a new workflow, press the "New" button at the top of the workflow list and select a template from the default workflows. Then edit the workflow name and press enter. You can also upload your workflow as a YAML file. + + + +To rename/delete a current workflow, press the "Edit" button at the top of the workflow list and then click on the context menu that appears next to the workflow items. + + + +You can use the "Clone" option to create a new workflow based on the currently available ones. You can select different workflows for different build scenarios (e.g., separate workflows for production and development). + + + +### Workflow Steps + + + +Appcircle will build your application with the steps defined in the [workflow](/workflows). Steps will be executed in order from the top to the bottom. + +You can customize each step for specific configurations with your application structure. Step parameters can be modified, outputs of each step can be used in another step, and step versions can be selected accordingly. + +### Workflow Marketplace + +Appcircle's powerful Workflow Editor has a built-in Workflow Marketplace that allows you to select and insert an unlimited number of steps into your workflow. + +You can find the full list of available workflow steps in our workflow marketplace at: + +[https://www.appcircle.io/integrations/](https://www.appcircle.io/integrations/) + +You can add platform-specific workflow steps, custom scripts, and other steps into your workflow and reorder them as you like. You can also remove the steps you don't need. You can back up your current workflow by clicking the **Download YAML** button at the bottom. + + + +To access the Workflow Marketplace, click on the **Manage Workflow** button. You will see the Workflow Marketplace on the right and your Workflow steps on the left. + +You can now drag and drop steps into your workflow. Any unwanted workflow steps can be removed by clicking on the delete button on the right side of each step. + +You can also reorder steps so that they will be executed in the order you specify. + + + +### Editing Workflow Steps + +Each workflow step has its own set of configuration options, which can be set by clicking on the step in the workflow screen. + +The first three items are common for all steps, and they are set individually for each step: + +- **Step Execution Active:** To enable/disable the step execution without removing it from the workflow. + +- **Always run this step even if the previous step fails:** If this option is enabled, getting a failed result on a previous workflow step will not directly terminate the build process so this specific workflow step can run. + +- **Continue with the next step even if this step fails:** If a step is optional or its result should not cause a build error, you can select this option to continue the workflow if this particular step fails. In default workflows, this option is `on` for specific steps. Since this step is active, the build status will appear as "Warning" if other steps in the build are successful. + + + +- **Workflow Step Version:** You can select a specific version of a step with which to execute your build. If you select a version with an asterisk (\*), you will receive the minor updates to the workflow step automatically. The major versions may include added or removed input fields, and manual version selection is required for major version updates. + +The items in the "Inputs" section are specific to that step. The reserved environment variables are assigned to these fields by default, and the values of these variables are set in the build configuration. + + + +:::info +Please note that the Workflow Step Version is managed by Appcircle. Native steps that are being used have their own versions. +::: + +When we start a build, if we have activated the "Continue with the next step even if this step fails" setting for a component we use in the workflow and this step fails during the build, Appcircle will show the build status as "Warning" if the build is completed successfully for other steps. + +In order to simulate the warning state and see its results on the pipeline, we can basically write a script that will fail in Custom Script. + + + +"Continue with the next step even if this step fails" must be `on` in this case. + + + +We are starting a build, and we see that it fails in the pipeline. + + + +And the build status will now appear as "Warning". + + + +For more information regarding build statuses, please refer to [manual build](/build/build-process-management/manual-builds#build-statuses) documentation. \ No newline at end of file diff --git a/docs/build/build-process-management/configurations.md b/docs/build/build-process-management/configurations.md new file mode 100644 index 000000000..2fb4be233 --- /dev/null +++ b/docs/build/build-process-management/configurations.md @@ -0,0 +1,195 @@ +--- +title: Configurations +description: Learn how to create and manage Build Profile configurations on Appcircle +tags: [build, build profile, configuration] +sidebar_position: 3 +--- + +import Screenshot from '@site/src/components/Screenshot'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Build Configuration + +Configuring a build profile requires completing some basic steps before starting a build. + +### Creating a configuration + +You may create a configuration profile that allows you to set different certificates and distribution channels that can be used with different workflows. + +- Click on **Configurations** to create configurations for different scenarios. + + + +- Click on the **New** button to create your first configuration. + + + +You can also create a configuration profile by uploading a saved YAML file. + +- You may change the name of the configuration or delete the ones you don't need. To do that, click on the edit button shown and the three dots on the configuration you want to edit/delete. + + + +If you have a configuration that you use constantly or want to quickly copy a configuration, you can use the "Configuration Clone" feature. + +The configuration clone feature will speed up your projects where you use many configurations. + +First, open the configuration process by clicking the edit button. + + + +Then click on the three dots next to the configuration you want to copy and click the "Clone" button in the mini window that opens. + + + +Another one is created identical to the configuration you want to clone. + + + +:::info +The name here is created by adding "\_copy_1" to the end of the main configuration name. For each configuration copied from now on, the name will be incremented to remain unique. +::: + +:::tip +Although the system gives a unique name for the copied configuration by default, you can give this configuration a new name using "Rename". +::: + +You can download your **Configuration** in YAML format to perform actions like sharing the settings you've configured or creating a duplicate on another **Build Profile** page. Follow these steps to download your **Configuration**: + +- Open the **Configuration** you've created. +- Locate the download button positioned at the bottom left of the Configuration interface. Click on the download button. + + + +Your _configuration.yaml_ file will be downloaded to your local system. + +:::tip +If you intend to copy the configuration to use on the same **Build Profile** page, consider using the **Clone Configuration** step as a quicker alternative. +::: + +:::caution +The downloaded YAML file is specific to the project type and can only be used for configuring the same type of project. For example, a YAML file generated for an iOS Swift project cannot be applied to an Android React Native project. Ensure that you use the correct YAML file for seamless configuration. +::: + +### Config Details + +Every build profile needs to know project details regardless of whether the project is an iOS or Android project. Project details can be entered manually or can be fetched from your project automatically by Appcircle if you click on **Autofill** button. + +You can also select your self-hosted runner from the **SELECT A POOL** dropdown. + + + Self-hosted Runners + + + + + + + + + + + +#### Build Priority + +The build priority configuration feature has three levels: Low, Medium, and High. + +These priority levels determine the order in which queued builds start, ensuring that higher-priority builds are initiated first. + +For example, if a high-priority build is added to the queue after a low-priority build, the high-priority build will start before the low-priority one. + +This feature allows for better management of build processes, enabling teams to prioritize critical updates and improvements efficiently. + + + +:::info +This feature is only available for organizations with Enterprise license. +::: + +### Signing configuration + +Both iOS and Android applications need to be digitally signed by their developers in order to be able to be installed on real devices or submitted to app stores. + +iOS certificates and Android keystores can be generated within Appcircle, or pre-obtained certificates can be uploaded. iOS provisioning profiles need to be obtained from the Apple Developer account and uploaded to Appcircle. + + + + + + + + + + +:::info +Please note that the [Automatic Code Signing](/signing-identities/apple-profiles#automatic-signing) option is only available for iOS projects. +::: + +You can either upload your iOS [certificate](/signing-identities/apple-certificates) and iOS [provisioning profile](/signing-identities/apple-profiles) or [Android Keystore](/signing-identities/android-keystores) from here or within the [Signing Identities](/signing-identities) module. + +### Distribution configuration + +Set up automated distribution for your builds by configuring distribution settings in Appcircle. This feature allows you to automatically send completed builds to selected modules, including Testing Distribution, Publish, or the Enterprise Store, ensuring a seamless deployment process. + +Simply enable the toggle of the module that you need and select the required profiles. + +#### Send to Testing Distribution + +Distribution configuration allows you to set which testing groups will receive your application after the build is complete. You can manually submit your binary to [Testing Distribution](/testing-distribution) profiles, or Appcircle can do it for you. + +In this window, you can select one or more of the previously created distribution profiles. You can use the "Manage Distribution Profiles" button above to quickly manage distribution profiles. + +Finally, check "Automatically Distribute to Testers" if you want your build to be automatically distributed to the selected testers or testing groups. + + + +#### Send to Publish + +Enabling "Automatically Distribute to Publish" will display the available [Publish](/publish-module) profiles for distribution. + + + +Simply select your relevant publish profiles, and Appcircle will automatically send your builds to the selected publish profiles. + +Please note that the publish profiles should be created within the publish module prior to configuring the distribution settings in the build profile. + +#### Send to Enterprise App Store + +- Navigate to the configuration, then go to the Distribution tab, and ensure that **Automatically Distribute to Enterprise App Store** is enabled. + + + +- Whenever a new **signed** build is created, it will be sent to the [Enterprise App Store](/enterprise-app-store). + +:::info +If you are building a binary for the first time or distributing it to the Enterprise App Store for the first time, a new Enterprise App Store profile will be created automatically. If there is an existing Enterprise App Store profile for your build, it will be directed to the existing profile. +::: + +### Versioning configuration + +You can set custom rules to manage the versioning of your app. You can increase both the build number and version number according to the rules you set. + + + +For more information please refer to the [Versioning](/versioning) documentation. + +### Environment variables configuration + +You can define variables and secrets to be incorporated during the build in the Environment Variables submodule so that you don't need to store certain keys and configurations within the repository. + + + +For more information regarding creating environment variables for build profiles, please refer to the related [Environment Variables](/build/build-environment-variables) documentation. \ No newline at end of file diff --git a/docs/build/build-process-management/index.md b/docs/build/build-process-management/index.md index 7527621e7..8d082eeca 100644 --- a/docs/build/build-process-management/index.md +++ b/docs/build/build-process-management/index.md @@ -1,25 +1,43 @@ --- -title: Build Process Management +title: Build Profile description: Learn how to manage your build processes effectively with Appcircle. Optimize your build configurations, manage branches, and automate your build pipeline for efficient app development. tags: [ - build process management, build profiles, - branch management, - manual builds, - automatic builds, - app development, - app deployment, - appcircle build process, + build profile management ] --- -# Build Profile Management +New to the Appcircle Build module? Follow our quick-start guide to build your iOS and Android apps in the cloud. -Master the management of your build profiles in Appcircle with the following features: +The Build Module allows you to streamline and automate your mobile app build flows. -- [**Profile Configuration**](/build/build-process-management/build-profile-configuration): Set up and manage the configurations for your build profiles. This involves specifying the settings that control the build process for each app version. +## [Profile Creation](/build/build-process-management/profile-creation) -- [**Branch Management**](/build/build-process-management/build-profile-branch-operations): Organize and handle different code branches within your repository. This section allows you to manage which branches are built and when. +Discover how to create and manage build profiles in Appcircle. This section guides you through the process of setting up new build profiles and listing existing ones, ensuring a streamlined workflow for your development and deployment needs. -- [**Manual and Automatic Builds**](/build/build-process-management/build-manually-or-with-triggers): Control how and when your builds are triggered. Opt for manual builds for greater control, or set up automatic builds to streamline your development pipeline whenever changes are pushed to your branches. \ No newline at end of file +## [Configurations](/build/build-process-management/configurations) + +Before initiating a build, certain essential steps must be completed to properly configure a build profile. This section outlines the fundamental configurations required to ensure a seamless build process. + +## [Workflows](/build/build-process-management/build-workflows) + +A workflow is a sequence of steps taken to build your applications. + +Each step has a different purpose, and it can be customized by modifying step parameters and inputs, running custom scripts, or reordering steps. + +## [Triggers](/build/build-process-management/build-manually-or-with-triggers) + +Builds can be triggered with various triggers, such as every push to the repository, pull/merge requests, or tagged pushes. + +## [Manual Builds](/build/build-process-management/manual-builds) + +Learn how to initiate manual builds using your build profile in Appcircle. This section provides step-by-step guidance on triggering builds manually to streamline your development workflow. + +## [Binary Actions](/build/build-process-management/binary-actions) + +Explore the different binary actions available in Appcircle after completing your builds. This section guides you through utilizing these actions to manage, distribute, and optimize your build artifacts efficiently. + +## [Branch Operations](/build/build-process-management/build-profile-branch-operations) + +When you connect to a repository, all branches of that repository will be displayed with the last 100 commits. Appcircle provides several features for easy management of branches. \ No newline at end of file diff --git a/docs/build/build-process-management/manual-builds.md b/docs/build/build-process-management/manual-builds.md new file mode 100644 index 000000000..b565762c7 --- /dev/null +++ b/docs/build/build-process-management/manual-builds.md @@ -0,0 +1,44 @@ +--- +title: Manual Builds +description: Learn how to start manual builds on Appcircle +tags: [build, manual build] +sidebar_position: 6 +--- + +# Starting a Manual Build + +To initiate a build in Appcircle, follow these steps: + +- Click on the Start Build button to begin the process. + + + +- Appcircle will prompt you to choose a configuration and workflow settings from the saved configurations. Select the appropriate settings that match your project requirements. + + + +- Once the configurations are selected, click the Start button to start the build. + + + +- Users can monitor the progress, results, and logs of the workflow steps in real-time via the interface. + + + +- After the build is complete, you have the option to download the build logs for reference or troubleshooting purposes. + + + +- Upon completion, the binary along with the artifacts will be displayed on the selected branch. These can be accessed for deployment or further use. + +By following these steps, you can efficiently manage and monitor your builds in Appcircle. + +For more detailed information on builds with different types of projects, please refer to the [Platform Build Guides](/build/platform-build-guides) documentation. + +#### Build Statuses + +- **Success**: The build has finished successfully with no failures in the workflow steps. +- **Failed**: The build has failed due to one or more workflow steps failing. +- **Warning**: The build has finished with a failed workflow step that does not affect the final outcome. +- **Timeout**: The build exceeded the timeout limit and ended prematurely. +- **Canceled**: The build was canceled by the user. \ No newline at end of file diff --git a/docs/build/build-process-management/profile-creation.md b/docs/build/build-process-management/profile-creation.md new file mode 100644 index 000000000..15b76a15a --- /dev/null +++ b/docs/build/build-process-management/profile-creation.md @@ -0,0 +1,103 @@ +--- +title: Profile Creation +description: Learn how to create Build Profiles on Appcircle +tags: [build, build profile] +sidebar_position: 1 +--- + +import Screenshot from '@site/src/components/Screenshot'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +A Build profile can be created by following these steps: + +## Creating a Profile + +Click on the **Add New** button located in the middle of the screen. If you already have an existing profile displayed on the build profile list, this button will be in the top right corner. + + + +Provide a unique name for the build profile and choose a target operating system (OS), which can be Android or iOS. + + + +After selecting the target OS, specify the corresponding target platform to set up a compatible build environment: + +iOS Platforms: +* [Objective-C / Swift](/build/platform-build-guides/building-ios-applications) +* [React Native](/build/platform-build-guides/building-react-native-applications) +* [Flutter](/build/platform-build-guides/building-flutter-applications) + +Android Platforms: +* [Java / Kotlin](/build/platform-build-guides/building-android-applications) +* [React Native](/build/platform-build-guides/building-react-native-applications) +* [Flutter](/build/platform-build-guides/building-flutter-applications) + +Click **Save** to proceed. + +Choose from the available repository connection options to link your project source code: + +* [GitHub](/build/manage-the-connections/adding-a-build-profile/connecting-to-github) +* [Azure](/build/manage-the-connections/adding-a-build-profile/connecting-to-azure) +* [Bitbucket](/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket) +* [GitLab](/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab) +* [Connect via SSH](/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh) +* Connect via URL +* [Connecting to Multiple Instances](/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance) + + + +:::info +If you have not previously connected to a Git provider on Appcircle, i.e., created a profile but have not connected a repository, you will not see any connection on this page. + +For more information on creating repository connections, please refer to the [connections](/build/manage-the-connections) guide. +::: + +To test drive Appcircle, you can find various sample projects on the [Appcircle GitHub page](https://github.com/appcircleio?q=sample) or you can just press the **Quick Start Using the Sample Repository** button to populate the repository with a compatible project based on the selected framework. + +For detailed instructions on connecting to each repository, refer to the [Connection Guides](/build/manage-the-connections/adding-a-build-profile). + +Once the repository connection is established, the build profile will be created successfully. Appcircle will then pull your branches, commits, and other information from your repository. You can now use the build profile to manage and deploy your projects. + + + +### Profile Listing + +Users can view their created build profiles by selecting the **Build Profiles** option in the left menu. They can also toggle between the profile card view and list view to easily locate profiles for different project types. + + + + + + + + + + +## Connection Settings + +After connecting a build profile to a Git provider, we can see the **"Connection Settings"** button in the build profile details. + + + +You can click on the "Connection Settings" button under the build profile name and URL to see detailed information about the connection. (PAT, OAuth) + +### OAuth + + + +### Personal Access Token (PAT) + + + +:::caution +If you added your repository via **multiple instances** using PAT (Personal Access Token), the "Connection Settings" will look different. + +You can review the [**Connecting Multiple Instances**](/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance#connection-settings-for-multiple-instances) page to learn how to use "Connection Settings" for multiple instances. +::: \ No newline at end of file diff --git a/docs/build/index.md b/docs/build/index.md index 2c27a4825..7f91c3f4e 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -7,24 +7,24 @@ tags: # Build Module Overview -The Build module in Appcircle streamlines your Continuous Integration and Continuous Deployment (CI/CD) workflows for mobile app development. It covers everything from code integration to managing your build profiles and post-build artifacts. +The Build Module in Appcircle streamlines your Continuous Integration and Continuous Deployment (CI/CD) workflows for mobile app development. It covers everything from code integration to managing your build profiles and post-build artifacts. -## [Connections](/build/manage-the-connections) +## [Build Profiles](/build/build-process-management) -Set up integrations with version control systems to sync your repositories, allowing for automated builds and deployments. +Follow our getting started guide to build your iOS and Android apps in the cloud. This guide will walk you through creating a build profile, managing profiles, branches, configurations, triggers, and more. -## [Build Profile Management](/build/build-process-management) +## [Environment Variables](/build/build-environment-variables) -Configure and manage your build profiles. Each profile allows you to maintain consistent settings and parameters for your app builds. +Environment variables let you extend your build configuration. There are several read-only Appcircle variables, and you can add your own variables to export and use during the build process in custom build scripts. -## [Platform Build Guides](/build/platform-build-guides) +## [Connections](/build/manage-the-connections) -Find detailed instructions for building applications across various platforms including iOS, Android, React Native, Flutter, and Ionic. +Set up integrations with version control systems to sync your repositories, allowing for automated builds and deployments. -## [Post-Build Operations](/build/post-build-operations) +## [Platform Build Guides](/build/platform-build-guides) -After the build process, manage and store your build artifacts securely. This includes the compiled binaries, logs, and any other relevant data. +Find detailed instructions for building applications across various platforms, including iOS, Android, React Native, Flutter, and Ionic. ## [Build History](/build/build-history) -Build History Report contains the list of build sessions initiated in a given time period. \ No newline at end of file +The Build History Report provides a comprehensive list of build sessions initiated within a selected time period. Users can filter their search based on date and organization for more precise tracking. Additionally, the report can be exported in CSV format for further analysis and record-keeping. \ No newline at end of file diff --git a/docs/build/manage-the-connections/_category_.json b/docs/build/manage-the-connections/_category_.json index 2655ba215..b3fdcd3fb 100644 --- a/docs/build/manage-the-connections/_category_.json +++ b/docs/build/manage-the-connections/_category_.json @@ -1,6 +1,6 @@ { "label": "Connections", - "position": 1, + "position": 3, "collapsed": true, "collapsible": true } diff --git a/docs/build/manage-the-connections/accessing-repositories-in-internal-networks-firewalls.md b/docs/build/manage-the-connections/accessing-repositories-in-internal-networks-firewalls.md index 0348210c2..ebfc9c4cf 100644 --- a/docs/build/manage-the-connections/accessing-repositories-in-internal-networks-firewalls.md +++ b/docs/build/manage-the-connections/accessing-repositories-in-internal-networks-firewalls.md @@ -32,4 +32,4 @@ For example, 77.92.124.2/27 means all IP addresses between 77.92.124.1 and 77.92 ::: -You can then [connect to the repository](/build/manage-the-connections/adding-a-build-profile#connect-your-repository) with your favorite Git provider. +You can then [connect to the repository](/build/manage-the-connections/adding-a-build-profile) with your favorite Git provider. diff --git a/docs/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance.md b/docs/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance.md index 87f2721f2..c49261824 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance.md @@ -8,9 +8,7 @@ sidebar_position: 7 import Screenshot from '@site/src/components/Screenshot'; import ContentRef from '@site/src/components/ContentRef'; -### Multiple Instances Using Git Providers (Bitbucket, GitLab, Azure DevOps) - -Multiple connection features have been introduced for connections made with PAT (Personnel Access Token) on Bitbucket, Azure DevOps, or GitLab. Thus, it is possible to add Bitbucket, Azure DevOps, or GitLab servers located in different environments by a single user. +Multiple connection features have been introduced for connections made with PAT (Personnel Access Token) on Bitbucket, Azure DevOps, or GitLab. Thus, it is possible for a single user to add Bitbucket, Azure DevOps, or GitLab servers located in different environments. For example, the same user can connect to two different instances, such as dev1.azure.companyname.com and dev2.azure.companyname.com. @@ -24,15 +22,15 @@ In order to use this feature, it is necessary to create a PAT on the provider. To add a git provider, PAT support is sufficient. There is no distinction between self-hosted and cloud-based. ::: -See below steps for an example case from Azure DevOps. +See below for steps for an example case from Azure DevOps. First of all, we select the relevant Git provider from the add new repository screen. - + Then click on the "Connect to an Azure DevOps Server" button in the window that opens. - + In the next window, fill in the relevant fields and click on the "Connect" button. @@ -58,7 +56,7 @@ However, you can connect an instance with that name for GitLab or Bitbucket Serv When we connect a repository using PAT (Personal Access Token) on multiple instances, you can use the "Connection Settings" button to view the PAT information and change the PAT information if there is a previously defined connection. -When we connect a repository using PAT over multiple instances, User Email and PAT list appears in the "Connection Settings". +When we connect a repository using PAT over multiple instances, the user email and PAT list appear in the "Connection Settings". diff --git a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-azure.md b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-azure.md index 664eb7917..f60e4a1e2 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-azure.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-azure.md @@ -10,36 +10,34 @@ import ContentRef from '@site/src/components/ContentRef'; # Connecting to Azure DevOps -## Connecting to Azure DevOps Services Cloud - ### Requirements You must enable third-party application access via OAuth. To do that, you can follow the steps: - Go to https://dev.azure.com -- Click to Organization setting from the left sidebar. -- Go to your policies settings below security. -- Enable Third-Party application access via OAuth. +- Click on the Organization setting from the left sidebar. +- Go to your policy settings below security. +- Enable third-party application access via OAuth. :::caution -If you don't enable third-party application access via the Oauth setting, you can't authorize Appcircle. +If you don't enable third-party application access via the OAuth setting, you can't authorize Appcircle. ::: ### Configuration Azure DevOps Services Setting on Appcircle If you authorize Appcircle to access your repositories on Azure DevOps, you can select the repository that you want to connect in the next screen. - + -After you click on **Azure**, the following screen will appear. This will let you choose between selecting a repository, which you have already authorized Appcircle to do, or ask your consent about authorizing more repositories. +After you click on **Azure**, the following screen will appear. This will let you choose between selecting a repository, which you have already authorized Appcircle to do, or asking your consent about authorizing more repositories. - + When you successfully authorize your account, the following screen will appear to let you select one for connection: -After the connection is successful, you can [view your newly created profile](/build/manage-the-connections/adding-a-build-profile/#view-the-newly-created-build-profile) and start building! +After the connection is successful, you can [view your newly created profile](/build/build-process-management/profile-creation#profile-listing) and start building! ## Connecting to Azure DevOps Server Repository @@ -55,7 +53,7 @@ Azure DevOps Server version must be **Azure DevOps Server 2020** or higher. First, select **Azure** and then **Connect to an Azure DevOps Server** through the menu: - + Fill in the relevant information about your Azure DevOps Server. If you are not sure what those are, contact your system administrator. @@ -69,7 +67,7 @@ Fill in the relevant information about your Azure DevOps Server. If you are not - For example: `https://azure.spacetech.com` -- **Owner Username**: Use the collection name on the Azure Devops Server. You can see collections on the left-hand side when you open your Azure Devops Server home page. +- **Owner Username**: Use the collection name on the Azure DevOps Server. You can see collections on the left-hand side when you open your Azure DevOps Server home page. - For example: `DefaultCollection` @@ -80,7 +78,7 @@ Fill in the relevant information about your Azure DevOps Server. If you are not ### Azure Devops Server That Is Upgraded From a TFS Server -If your Azure Devops Server is upgraded from a TFS server, you should identify your Azure Devops Server URL. +If your Azure DevOps Server is upgraded from a TFS server, you should identify your Azure DevOps Server URL. - Copy a repository clone URL for any git repository. - Check if your URL has an unexpected **path** in the URL. diff --git a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket.md b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket.md index 12c29de54..57fb886ae 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket.md @@ -11,25 +11,47 @@ import NeedHelp from '@site/docs/\_need-help.mdx'; # Connecting to Bitbucket -## Connecting to bitbucket.com +If you authorize Appcircle to access your repositories on Bitbucket, you can select the repository that you want to connect in the next screen. -If you authorize Appcircle to access your repositories on BitBucket, you can select the repository that you want to connect in the next screen. + - +After you click on **Bitbucket**, the following screen will appear. This will let you choose between selecting a repository that you are already authorized to do with Appcircle or asking your consent about authorizing more repositories. -After you click on **Bitbucket**, the following screen will appear. This will let you choose between selecting a repository which you are already authorized Appcircle to do or ask your consent about authorizing more repositories. - - + When you successfully authorize your account, the following screen will appear to let you select one for connection: -After the connection is successful, you can [view your newly created profile](/build/manage-the-connections/adding-a-build-profile/#view-the-newly-created-build-profile) and start building! +After the connection is successful, you can [view your newly created profile](/build/build-process-management/profile-creation#profile-listing) and start building! + +## Connecting to Bitbucket Cloud Repository + +To connect to a Bitbucket Cloud repository using either OAuth or Personal Access Token, + +- OAuth Connection + +Clicking on Get Repositories from Bitbucket Cloud for the first time will require application access to Appcircle, and this access will require these permissions in order to work properly. + +- PAT (Personal Access Token) Connection or Bitbucket App Password + +Clicking on Connect to a Bitbucket server, which can be selected to connect to self-hosted and PAT connections, will require a token or password. Generating an app password or a PAT for Appcircle will require a list of permissions down below. + +### OAuth Permissions for Bitbucket Integration + +The following table details the OAuth permissions required for Appcircle to connect with Bitbucket. These permissions grant read access to projects, repositories, pull requests, and webhooks, ensuring proper functionality when integrating with Bitbucket via OAuth. + +| Scope | Permission | Description | +|--------------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Account | Email | Provides access to view the user's primary email address. | +| Project | Read | Provides access to view the projects the user has access to view. Read access (repository) to all the repositories in the projects is also granted. | +| Repository | Read | Provides access to view all the repositories the user has access to view, including the source code, Issues, and Wiki. This does not include pull requests. | +| Pull Request | Read | Provides access to view and list pull requests on the repositories the user has access to view. This permission (scope) also allows the user to create and resolve tasks. | +| Webhooks | Read & Write | Required for webhook operations. For Appcircle triggers to work. | ## Connecting to Bitbucket Self Hosted Repository -Overall process is similar with private repository connection through SSH, but Appcircle allows to directly connect through Bitbucket Self Hosted URL. +The overall process is similar with a private repository connection through SSH, but Appcircle allows you to directly connect through the Bitbucket Self-Hosted URL. :::caution @@ -39,9 +61,9 @@ Bitbucket's version must be **7.14** or higher. First, select **Bitbucket** then **Connect to a Bitbucket Server** through the menu: - + -Fill the relevant information about your Bitbucket self-hosted module. If you are not sure what those are, contact your system administrator. +Fill in the relevant information about your Bitbucket self-hosted module. If you are not sure what those are, contact your system administrator. @@ -49,11 +71,11 @@ Fill the relevant information about your Bitbucket self-hosted module. If you ar ### Connection Notice -For Appcircle to connect to the Self Hosted Bitbucket Instance, your connection must be reachable over the internet. +For Appcircle to connect to the self-hosted Bitbucket instance, your connection must be reachable over the internet. ::: -Is your self-hosted Bitbucket instance under enterprise firewall? Learn which IP addresses and ports Appcircle uses to function under the whitelist documentation: +Is your self-hosted Bitbucket instance under an enterprise firewall? Learn which IP addresses and ports Appcircle uses to function under the whitelist documentation: Accessing Repositories in Internal Networks (Firewalls) @@ -77,7 +99,7 @@ Bitbucket doesn't allow scoped repository permissions like GitHub. Therefore the ::: -You may create access token to specific project or a repository which can help you to restrict the access level of the token. +You may create an access token for a specific project or a repository, which can help you to restrict the access level of the token. ### Create HTTP access tokens for projects or repositories diff --git a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-github.md b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-github.md index 4e0320061..47a221e2b 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-github.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-github.md @@ -18,13 +18,13 @@ In such a case, only the selected repositories will be listed. To be able to vie :::info -For connection to GitHub, Appcircle uses GitHub App instead of GitHub OAuth. GitHub App is more secure and newer way implemented by GitHub to external apps to communicate within GitHub in a better fashion. +For connection to GitHub, Appcircle uses GitHub App instead of GitHub OAuth. GitHub App is a more secure and newer way implemented by GitHub for external apps to communicate within GitHub in a better fashion. ::: - + -After you click on **GitHub**, the following screen will appear. This will let you choose between selecting a repository which you are already authorized Appcircle to do or ask your consent about authorizing more repositories. +After you click on **GitHub**, the following screen will appear. This will let you choose between selecting a repository that you are already authorized to do with Appcircle or asking your consent about authorizing more repositories. @@ -32,7 +32,7 @@ When you successfully authorize your repository or repositories, the following s -After the connection is successful, you can [view your newly created profile](/build/manage-the-connections/adding-a-build-profile/#view-the-newly-created-build-profile) and start building! +After the connection is successful, you can [view your newly created profile](/build/build-process-management/profile-creation#profile-listing) and start building! ## FAQ @@ -40,6 +40,6 @@ After the connection is successful, you can [view your newly created profile](/b If you are unable to grant access to a specific organization while connecting to GitHub, it is likely that the permission for Appcircle needs an update from the organization application access settings. -To resolve, go to Organization Settings ->Third-party access and press edit next to Appcircle to authorize it for the organization. +To resolve, go to Organization Settings -> Third-party access and press edit next to Appcircle to authorize it for the organization. diff --git a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab.md b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab.md index 75e62d0ed..9b3997352 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab.md @@ -10,25 +10,23 @@ import ContentRef from '@site/src/components/ContentRef'; # Connecting to GitLab -## Connecting to gitlab.com - If you authorize Appcircle to access your repositories on GitLab, you can select the repository that you want to connect in the next screen. - + -After you click on **GitLab**, the following screen will appear. This will let you choose between selecting a repository which you are already authorized Appcircle to do or ask your consent about authorizing more repositories. +After you click on **GitLab**, the following screen will appear. This will let you choose between selecting a repository that you are already authorized to do with Appcircle or asking your consent about authorizing more repositories. - + When you successfully authorize your account, the following screen will appear to let you select one for connection: -After the connection is successful, you can [view your newly created profile](/build/manage-the-connections/adding-a-build-profile/#view-the-newly-created-build-profile) and start building! +After the connection is successful, you can [view your newly created profile](/build/build-process-management/profile-creation#profile-listing) and start building! ## Connecting to GitLab Self Hosted Repository -Overall process is similar with private repository connection through SSH, but Appcircle allows to directly connect through GitLab Self Hosted URL. +The overall process is similar to a private repository connection through SSH, but Appcircle allows you to directly connect through GitLab Self Hosted URL. :::caution @@ -38,7 +36,7 @@ GitLab's version must be **13.12.9** or higher. First, select **GitLab** and then **Connect to a Self-Managed GitLab Instance** through the menu: - + Fill the relevant information about your GitLab self-hosted module. If you are not sure what those are, contact your system administrator. @@ -95,7 +93,7 @@ GitLab has two kinds of token at their Self Hosted instance: - [Personal Access Token](https://docs.gitlab.com/ee/security/token_overview.html#personal-access-tokens) - [Project Access Token](https://docs.gitlab.com/ee/security/token_overview.html#project-access-tokens) -Both works to connect your repository through Appcircle. That being said, **Project Access Token **is used to authorize a single project(repository) and **Personal Access Token **is used to authorize every repository the user has access to. +Both works to connect your repository through Appcircle. That being said, **Project Access Token** is used to authorize a single project(repository) and **Personal Access Token** is used to authorize every repository the user has access to. :::info @@ -140,7 +138,7 @@ For detailed instructions on how to install custom public certificates and confi Alternatively, you can choose to disable SSL verification for your AppCircle server's webhook connection in GitLab. While this means that GitLab will not attempt to validate the certificate, it is important to note that webhooks will still be sent over an encrypted HTTPS connection but in an insecure way. :::caution -This approach can create security vulnerabilities such as man-in-the middle attacks. +This approach can create security vulnerabilities such as man-in-the-middle (MITM) attacks. ::: Take the following steps to disable the SSL verification of the webhook: @@ -149,7 +147,7 @@ Take the following steps to disable the SSL verification of the webhook: 2. Open the webhook settings of that Git repository. 3. Click on the **Edit** button next to the webhook. 4. Scroll down to see the **SSL verification** setting. -5. De-select the **Enable SSL verification** checkbox. +5. Deselect the **Enable SSL verification** checkbox. diff --git a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh.md b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh.md index ce44aaea9..9555c89de 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh.md @@ -14,7 +14,7 @@ import TabItem from '@theme/TabItem'; ### Using Direct SSH Key -If you use a private repository using an SSH Key, you need to have an SSH key pair ready and enter your private key to Appcircle so Appcircle can access your repository. +If you use a private repository using an SSH Key, you need to have an SSH key pair ready and enter your private key into Appcircle so Appcircle can access your repository. :::caution @@ -24,9 +24,9 @@ For the SSH key field in the repository connection, the private key is required. :::caution -If you are using Azure Devops Server as a git provider, its version must be 2022 or later. +If you are using Azure DevOps Server as a Git provider, its version must be 2022 or later. -Azure Devops Server 2020 and older versions are not supported due to reduced security. +Azure DevOps Server 2020 and older versions are not supported due to reduced security. ::: @@ -63,19 +63,19 @@ SSH keys generated should not contain a password. If ssh-keygen prompts you for ::: -Two files will be created as `appcircle-ssh.pub` (Public key) and `appcircle-ssh` (Private key) +Two files will be created as `appcircle-ssh.pub` (Public key) and `appcircle-ssh` (Private key). You can then run the `cat ./appcircle-ssh` command and enter its output to Appcircle and run the `cat ./appcircle-ssh.pub` command and enter its output to the SSH keys section of the Git provider. -Select **Connect via SSH **through the connection selection +Select **Connect via SSH** through the connection selection. - + Then, enter your relevant information to connect to the private repository: -After the connection is successful, you can [view your newly created profile](/build/manage-the-connections/adding-a-build-profile/#view-the-newly-created-build-profile) and start building! +After the connection is successful, you can [view your newly created profile](/build/build-process-management/profile-creation#profile-listing) and start building! :::info @@ -114,7 +114,7 @@ AWS CodeCommit requires the creation of a dedicated user for repository connecti -- Once you login with the newly generated user and copy the repository URL in SSH format, you will receive URL as follows: `ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo` +- Once you log in with the newly generated user and copy the repository URL in SSH format, you will receive the URL as follows: `ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo` - For the SSH connection to be initialized, you need to add the public key to your URL to have it in the following format, which then can be entered in Appcircle to be used in SSH connections.`ssh://Your-SSH-Key-ID@git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo` ## FAQ @@ -129,8 +129,8 @@ Using multiple SSH keys is not recommended. Instead, you should create a single If you want to use multiple SSH keys, you need to complete the below steps: -- Add your SSH key(s) as environment variable group as a file. -- Select that environment group on your config screen +- Add your SSH key(s) as an environment variable group as a file. +- Select that environment group on your config screen. - Use the below custom script to add that key. - Each key name should be unique. Appcircle's Activate SSH component uses `appcircle_ssh` as a key name. @@ -176,7 +176,7 @@ Please refer to [this guide for creating a user for SSH connections](https://doc -- Once you login with the newly generated user and copy the repository URL in SSH format, you will receive URL as follows: `ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo` +- Once you log in with the newly generated user and copy the repository URL in SSH format, you will receive the URL as follows: `ssh://git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo` - For the SSH connection to be initialized, you need to add the public key to your URL to have it in the following format, which then can be entered in Appcircle to be used in SSH connections.`ssh://Your-SSH-Key-ID@git-codecommit.us-east-2.amazonaws.com/v1/repos/MyDemoRepo` import NeedHelp from '@site/docs/\_need-help.mdx'; diff --git a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-public-repository.md b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-public-repository.md index 62beababb..210bcdd37 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-public-repository.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/connecting-to-public-repository.md @@ -9,11 +9,11 @@ import Screenshot from '@site/src/components/Screenshot'; # Connecting to Public Repository -Since public repositories doesn't require any authentication or connection, the actions that can be taken with public repositories are limited. You will only have read only access towards the specified repository. Only use public repositories if you plan to use the profile for: +Since public repositories don't require any authentication or connection, the actions that can be taken with public repositories are limited. You will only have read-only access to the specified repository. Only use public repositories if you plan to use the profile for: - Testing & Previewing Appcircle - Benchmarking build times to see how fast we are 🚀 -- Not planning to use the profile for long term +- Not planning to use the profile for the long term. #### Using a Git Provider? @@ -35,17 +35,17 @@ When you enter the profile after the build, the following screen will appear. Cl :::tip -Clicking **Quick start using the sample repository **will also connect the relevant sample project with public connection. +Clicking **Quick start using the sample repository** will also connect the relevant sample project with a public connection. ::: - + -After you click on **Connect via URL**, the following screen will appear and let you enter an URI +After you click on **Connect via URL**, the following screen will appear and let you enter an URI. -Enter the URL of your repository, or continue with sample project if you plan to preview Appcircle. +Enter the URL of your repository, or continue with the sample project if you plan to preview Appcircle. :::tip @@ -53,7 +53,7 @@ Public connection refers to the HTTP(s) connection by Git Providers. SSH links i ::: -After the connection is successful, you can [view your newly created profile](/build/manage-the-connections/adding-a-build-profile/#view-the-newly-created-build-profile) and start building! +After the connection is successful, you can [view your newly created profile](/build/build-process-management/profile-creation#profile-listing) and start building! :::info diff --git a/docs/build/manage-the-connections/adding-a-build-profile/index.md b/docs/build/manage-the-connections/adding-a-build-profile/index.md index 8cf040f29..4af0ae4d6 100644 --- a/docs/build/manage-the-connections/adding-a-build-profile/index.md +++ b/docs/build/manage-the-connections/adding-a-build-profile/index.md @@ -7,41 +7,15 @@ sidebar_position: 1 import Screenshot from '@site/src/components/Screenshot'; -# Adding a Build Profile & Connecting a Repository +# Connect your repository -New to Appcircle Build module? Follow our quick start guide to build your iOS and Android apps in the cloud. +You can connect GitHub through a GitHub app or Bitbucket and GitLab repositories to your build profile through OAuth apps. Alternatively, you can connect private repositories through SSH and public repositories directly on GitHub, Bitbucket, GitLab, and other compatible Git providers such as Azure DevOps and AWS CodeCommit. ([Please refer here for more information on AWS CodeCommit connections.](/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh#how-to-connect-to-aws-codecommit-repositories-through-ssh-1)) -The Build Module allows you to streamline and automate your mobile app build flows. +You can also connect to your self-hosted Bitbucket and GitLab account directly within Appcircle. -:::info +If you authorize Appcircle to connect to your Github, BitBucket, or GitLab account, you can auto-build your project with hooks, get build statuses, and the full list of commits. If you connect to a repository through SSH or through a public URL, you need to [set up webhooks manually](/build/build-process-management/build-manually-or-with-triggers#setting-up-manual-webhooks-for-ssh-and-public-repositories). -The Build Module is the first step to automate your CI/CD processes via Appcircle. - -::: - -## Create a build profile (app) - -A build profile is an app that you can build in a target OS and framework. - -To create your first build profile, click on the orange "Add New" button on the top left of the screen. - - - -Enter a name for your build profile and select the target operating system (iOS or Android) and target platform. - - - -## Connect your repository - -You can connect GitHub through a GitHub app or Bitbucket and GitLab repositories to your build profile through OAuth apps. Alternatively, You can connect private repositories through SSH and public repositories directly on GitHub, Bitbucket, GitLab, and other compatible git providers such as Azure DevOps and AWS CodeCommit. ([Please refer here for more information on AWS CodeCommit connections.](/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh#how-to-connect-to-aws-codecommit-repositories-through-ssh-1)) - -You can also connect to your Self Hosted Bitbucket and GitLab account directly within Appcircle. - -If you authorize Appcircle to connect to your Github, BitBucket, or GitLab account, you can auto-build your project with hooks, get build statuses and the full list of commits. If you connect to a repository through SSH or through a public URL, you need to [set up webhooks manually](/build/build-process-management/build-manually-or-with-triggers#setting-up-manual-webhooks-for-ssh-and-public-repositories). - -To test drive Appcircle, you can find various sample projects in the [Appcircle GitHub page](https://github.com/appcircleio?q=sample) or you can just press on the **Quick start using the sample repository** button to populate the repository URL field with a compatible project based on the selected framework. - - + When the "Autofill" toggle is activated on the **Select Repository** popup, Appcircle will try to create a default configuration using the selected repository and fill in the necessary fields. @@ -51,43 +25,25 @@ When the "Autofill" toggle is activated on the **Select Repository** popup, Appc When you have exceeded the build limit of your plan, Appcircle will not be able to **Autofill** your build profile, although you activated the toggle. ::: -Refer to the relative documents under this page about the connections and differences between connection types: - -- [Connect to GitHub](/build/manage-the-connections/adding-a-build-profile/connecting-to-github) -- [Connect to Bitbucket](/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket) -- [Connect to GitLab](/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab) -- [Connect to Private Repository via SSH Key](/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh) -- [Connect to Public Repository](/build/manage-the-connections/adding-a-build-profile/connecting-to-public-repository) - -## View the newly created build profile - -You will see your build profile once it has been created. Click on the build profile to connect a repository and fetch your code to Appcircle. - -Appcircle will then pull your branches, commits, and other information from your repository. - - - - - -### Delete a Build Profile - -In order to delete a build, simply click on the Three Dot and click delete. - - - -After the prompt, the profile will be deleted. +You can refer to the links below for a detailed explanation on connecting a repository from GitHub, GitLab, Azure, and other platforms: -In order to free up storage in your organization, you should also remove the other references pointing to the artifact. In example, if you have the same artifact on the testing distribution, you should also delete those artifacts as well. +* [Connecting to GitHub](/build/manage-the-connections/adding-a-build-profile/connecting-to-github) +* [Connecting to GitLab](/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab) +* [Connecting to Bitbucket](/build/manage-the-connections/adding-a-build-profile/connecting-to-bitbucket) +* [Connecting to Azure DevOps](/build/manage-the-connections/adding-a-build-profile/connecting-to-azure) +* [Connecting to Public Repository](/build/manage-the-connections/adding-a-build-profile/connecting-to-public-repository) +* [Connecting to Private Repository via SSH](/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh) +* [Connecting to Multiple Instances](/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance) ## FAQ ## Repository Connection Issues -Please note that currently only Git repositories are supported. Any third party version control repositories need to be transferred to a proper Git repository on either Github or Bitbucket. +Please note that currently only Git repositories are supported. Any third party version control repositories need to be transferred to a proper Git repository on either GitHub or Bitbucket. ### **How to change your connected GitHub, Bitbucket, or GitLab account?** -You will need to go to your Github, Bitbucket, or GitLab account and revoke access to Appcircle and then reconnect your account from Appcircle. +You will need to go to your GitHub, Bitbucket, or GitLab account and revoke access to Appcircle and then reconnect your account from Appcircle. ### Unable to see the repositories in the connected repository provider @@ -95,8 +51,8 @@ Please check if you have owner/admin access in the specific organization from wh ### Error accessing the repository. Please check if the repository exists or if you have the required privileges. -- Only members who have admin role on repository or are owner of the organization can install the Github App in an organization that owns that repository. -- Only members who have admin role on a repository or are owner of the organization can connect a repository to a profile. +- Only members who have an admin role on the repository or are owners of the organization can install the GitHub app in an organization that owns that repository. +- Only members who have an admin role on a repository or are owners of the organization can connect a repository to a profile. If you still can't solve your issues, ask on our Slack page. Our community and our support engineers will help you whenever they're available: diff --git a/docs/build/manage-the-connections/manage-the-connections.md b/docs/build/manage-the-connections/manage-the-connections.md index a3c4c707b..a8c2db0f4 100644 --- a/docs/build/manage-the-connections/manage-the-connections.md +++ b/docs/build/manage-the-connections/manage-the-connections.md @@ -2,7 +2,7 @@ title: Manage the Connections description: The Connections page is a feature where we can check and edit the connections of the Git providers we are connected to. tags: [build, connections, git providers, oauth, pat, personal access token] -sidebar_position: 11 +sidebar_position: 1 --- import Screenshot from '@site/src/components/Screenshot'; @@ -13,128 +13,20 @@ The Connections page is a feature where we can check and edit the connections of On this page, you can view **OAuth** and **PAT** (Personal Access Token) connections. - + :::info If you have not previously connected to a Git provider on Appcircle, i.e., created a profile and not connected a repository, you will not see any connection on this page. ::: -## Managing OAuth Connections +## Connection Guides -### Revoke OAuth Connections +You can connect GitHub through a GitHub app or Bitbucket and GitLab repositories to your build profile through OAuth apps. Alternatively, you can connect private repositories through SSH and public repositories directly on GitHub, Bitbucket, GitLab, and other compatible Git providers such as Azure DevOps and AWS CodeCommit. -**Revoke Token** revokes the token of the Git provider on the Appcircle side. On the Git provider side, the token is still active and available. Appcircle cannot revoke the token from the provider. +## Connection Management - +You can connect GitHub, GitLab, Bitbucket and Azure remote repositories. Different types of connections have different connection details in the connection settings. -A revoked connection disconnects all build profiles connected to the respective Git provider. In this case, Appcircle shows a clear warning message. Here, you can see all the affected profiles. +## Accessing Internal Networks - - -When we revoke a Git provider successfully, the "Revoke Token" button disappears. If we reconnect using the **Refresh Token** button, the "Revoke Token" button will appear again. - - - -:::info -If we open one of the affected build profiles after applying a revoke for a Git provider, we should see the disconnected build profile state in the UI. - -If we reconnect this profile, not only the related build profile but also all other build profiles belonging to that Git provider will be connected. -::: - -### Reconnect OAuth Connections - -If we want to reconnect to the Git provider, we can use the **Refresh Token** button. - -The `refresh token` is received while connecting to the Git provider, and it's used when needed, for instance, in reconnection or token expiration cases. - - - -The refreshing connection action reconnects all previously linked and disconnected build profiles of the corresponding Git provider in Appcircle. Here again, all affected build profiles will be shown. - - - -When the **Refresh Token** button is clicked, Appcircle redirects to the relevant Git provider's page. After giving the necessary permissions there, the connection will be restored. - -:::info -If the connection to the Git provider is active and the **Refresh Token** button is clicked, Appcircle will re-establish the connection. -::: - -## Managing PAT Connections - -The PAT connection list section on the right-hand side has a list of connections that were made using a personal access token. - - - -The list first shows the logo of the Git provider we're connecting to, then the name we gave to the connection (when multiple instances are used), and finally the URL of the Git provider we're connecting to. - -### Adding PAT Connection - -The "Add New" button at the top of the PAT connection list on the right side allows us to add PAT (Personal Access Token) without creating a new build profile. Then you can use that PAT connection on existing build profiles or while adding a new build profile. - - - -After clicking on the "Add New" button, Appcircle will ask us to select a Git provider and fill in the necessary information according to the Git provider, just like in the build profile PAT connection. - - - -:::info -The name you defined in the **Connection Name** section must be unique for each Git provider. - -For example, if you have created a PAT named "my-secret-pat" for GitHub, you cannot create another PAT with the same name for GitHub. - -But you can create a PAT named "my-secret-pat" for GitLab or Bitbucket, for instance. -::: - - - -:::info -In Azure DevOps Server connections, the **Owner Username** field on Appcircle corresponds to the **Collection Name** on Azure. -::: - - - -Now you're ready to use the added PAT connection in your build profiles. While making a new connection, you can see the PAT connection in the available connections list after selecting Git provider. - -### Editing PAT Connections - -We can see the details of the PAT connection with the **Edit** button on the right side. These are **Provider**, **Instance URL**, **Token Owner**, **Token**, and **PAT**. - - - -In the **Connection Edit**, we can change the PAT (Personal Access Token) value. - -However, we must make sure that the value we change here is correct and that it was created on the Git provider correctly. Otherwise, the affected build profile or profiles will not be connected. - - - -:::caution -In the **Connection Edit**, you can see the build profiles where PAT is used under "Affected Build Profiles". - -Changing a PAT value will affect all the build profiles shown here. -::: - -:::tip -While editing PAT connections, you can also write the PAT value using environment variables. - -You can review [Using Environment Variables For SSH And PAT (Personal Access Token) Connections](/environment-variables/managing-variables#using-environment-variables-for-ssh-and-pat-personal-access-token-connections-of-the-git-provider) page for details. -::: - -### Deleting PAT Connections - -You can delete a Personal Access Token (PAT) connection by clicking on the **Delete** next to the respective entry in your list of PAT connections. - - - -Upon clicking the **Delete** button, Appcircle will prompt you to enter the name of the PAT Connection to confirm the deletion operation. After entering the connection name, simply click **Delete** on the pop-up screen. - - - -:::warning -If you have an existing Build profile that would be affected by the deletion of the PAT Connection, Appcircle will display a warning message listing the affected builds. - -You will need to disconnect them before you can delete the PAT Connection. - -For more information about disconnecting a Build profile please refer to the related [documentation](/build/manage-the-connections/reconnect-change-provider#disconnect-build-profile). -::: - - +In certain cases, the source codes of the apps may be stored in internal repositories instead of the cloud providers. If these internal repositories are accessible from the public internet, then you can use Appcircle without any additional configuration. \ No newline at end of file diff --git a/docs/build/manage-the-connections/reconnect-change-provider.md b/docs/build/manage-the-connections/reconnect-change-provider.md index 44a7d95b3..b2d685cd8 100644 --- a/docs/build/manage-the-connections/reconnect-change-provider.md +++ b/docs/build/manage-the-connections/reconnect-change-provider.md @@ -2,7 +2,7 @@ title: Connection Management description: Learn how to manage connections in Appcircle tags: [build, manage, connections] -sidebar_position: 12 +sidebar_position: 2 --- import Screenshot from '@site/src/components/Screenshot'; @@ -11,7 +11,7 @@ import Screenshot from '@site/src/components/Screenshot'; You can see the connection details by clicking the **"Connection Settings"** button in the build profile. - + Different types of connections have different connection details in the connection settings. @@ -19,7 +19,7 @@ Different types of connections have different connection details in the connecti For an OAuth connection, the details will be **"Provider"**, **"Token Owner"**, **"Code"**, **"Expire Access Token Date"**, **"Expire Refresh Token Date"**, **"Refresh Token"**, and **"Token"**. - + ### PAT Connection @@ -37,7 +37,7 @@ You only need to make sure that the modified token has the required authorizatio You can disconnect the build profile from the Git provider by using the **Disconnect** button below. - + When you click on the "Disconnect" button, Appcircle will bring up a warning dialog box for confirmation. @@ -49,7 +49,7 @@ When we open a disconnected build profile, Appcircle will bring us a popup to qu If you do not want to connect again at that moment, you can do it later by clicking the "Reconnect" button next to the "Connection Settings". - + :::info If you disconnect a build profile, only that build profile is disconnected from the Git provider. @@ -67,13 +67,13 @@ Appcircle allows changing the Git provider while reconnecting a profile that has For example, assume that a build profile was previously connected to GitLab and then its Git repository had been moved to GitHub. In this case, you can select the new Git provider for that build profile by clicking the "Reconnect" button next to "Connection Settings". - + Appcircle will display the Git providers and "Connect via SSH" connection options in a selectable list. Here you can select the Git provider you want to change or the "Connect via SSH" method regardless of the Git provider. - + Once the connection operations are completed, the Git provider redirects to the Appcircle build profile with the repository selection window. @@ -96,7 +96,7 @@ You can select one of the listed options and switch to that one without consider ::: :::info -While changing the Git provider, your previous builds, tests, configurations, workflows, triggers and branch list will not be deleted. +While changing the Git provider, your previous builds, tests, configurations, workflows, triggers, and branch list will not be deleted. ::: ## Change Owner @@ -104,7 +104,7 @@ While changing the Git provider, your previous builds, tests, configurations, wo The **token owner** of a build profile can now be changed without the need to create a new build profile on Appcircle. The **Change Owner** button in the build profile **Connection** detail will help you change the connection ownership so that you can resolve the broken connections or misconfigured repository authorization cases easily by yourself. :::info -To use this feature, the user must have previously connected to the relevant Git provider on Appcircle via [OAuth](/build/manage-the-connections/#managing-oauth-connections). +To use this feature, the user must have previously connected to the relevant Git provider on Appcircle via [OAuth](/build/manage-the-connections/reconnect-change-provider#managing-oauth-connections). ::: :::info @@ -129,4 +129,124 @@ In addition, the user who wants to take ownership of the connection must also ha When the process is completed successfully, you can click on the **Connection Settings** button again to see the changed ownership of the build profile connection. In the window that's opened, there won't be a **Change Owner** button because you are now the profile owner. - + + +## Managing OAuth Connections + +### Revoke OAuth Connections + +**Revoke Token** revokes the token of the Git provider on the Appcircle side. On the Git provider side, the token is still active and available. Appcircle cannot revoke the token from the provider. + + + +A revoked connection disconnects all build profiles connected to the respective Git provider. In this case, Appcircle shows a clear warning message. Here, you can see all the affected profiles. + + + +When we revoke a Git provider successfully, the "Revoke Token" button disappears. If we reconnect using the **Refresh Token** button, the "Revoke Token" button will appear again. + + + +:::info +If we open one of the affected build profiles after applying a revoke for a Git provider, we should see the disconnected build profile state in the UI. + +If we reconnect this profile, not only the related build profile but also all other build profiles belonging to that Git provider will be connected. +::: + +### Reconnect OAuth Connections + +If we want to reconnect to the Git provider, we can use the **Refresh Token** button. + +The `refresh token` is received while connecting to the Git provider, and it's used when needed, for instance, in reconnection or token expiration cases. + + + +The refreshing connection action reconnects all previously linked and disconnected build profiles of the corresponding Git provider in Appcircle. Here again, all affected build profiles will be shown. + + + +When the **Refresh Token** button is clicked, Appcircle redirects to the relevant Git provider's page. After giving the necessary permissions there, the connection will be restored. + +:::info +If the connection to the Git provider is active and the **Refresh Token** button is clicked, Appcircle will re-establish the connection. +::: + +## Managing PAT Connections + +The PAT connection list section on the right-hand side has a list of connections that were made using a personal access token. + + + +The list first shows the logo of the Git provider we're connecting to, then the name we gave to the connection (when multiple instances are used), and finally the URL of the Git provider we're connecting to. + +### Adding PAT Connection + +The "Add New" button at the top of the PAT connection list on the right side allows us to add PAT (Personal Access Token) without creating a new build profile. Then you can use that PAT connection on existing build profiles or while adding a new build profile. + + + +After clicking on the "Add New" button, Appcircle will ask us to select a Git provider and fill in the necessary information according to the Git provider, just like in the build profile PAT connection. + + + +:::info +The name you defined in the **Connection Name** section must be unique for each Git provider. + +For example, if you have created a PAT named "my-secret-pat" for GitHub, you cannot create another PAT with the same name for GitHub. + +But you can create a PAT named "my-secret-pat" for GitLab or Bitbucket, for instance. +::: + + + +:::info +In Azure DevOps Server connections, the **Owner Username** field on Appcircle corresponds to the **Collection Name** on Azure. +::: + + + +Now you're ready to use the added PAT connection in your build profiles. While making a new connection, you can see the PAT connection in the available connections list after selecting the Git provider. + +### Editing PAT Connections + +We can see the details of the PAT connection with the **Edit** button on the right side. These are **Provider**, **Instance URL**, **Token Owner**, **Token**, and **PAT**. + + + +In the **Connection Edit**, we can change the PAT (Personal Access Token) value. + +However, we must make sure that the value we change here is correct and that it was created on the Git provider correctly. Otherwise, the affected build profile or profiles will not be connected. + + + +:::caution +In the **Connection Edit**, you can see the build profiles where PAT is used under "Affected Build Profiles". + +Changing a PAT value will affect all the build profiles shown here. +::: + +:::tip +While editing PAT connections, you can also write the PAT value using environment variables. + +You can review [Using Environment Variables For SSH And PAT (Personal Access Token) Connections](/build/build-environment-variables#using-environment-variables-for-ssh-and-pat-personal-access-token-connections-of-the-git-provider) page for details. +::: + +### Deleting PAT Connections + +You can delete a Personal Access Token (PAT) connection by clicking on the **Delete** next to the respective entry in your list of PAT connections. + + + +Upon clicking the **Delete** button, Appcircle will prompt you to enter the name of the PAT Connection to confirm the deletion operation. After entering the connection name, simply click **Delete** on the pop-up screen. + + + +:::warning +If you have an existing Build profile that would be affected by the deletion of the PAT Connection, Appcircle will display a warning message listing the affected builds. + +You will need to disconnect them before you can delete the PAT connection. + +For more information about disconnecting a build profile please refer to the related [documentation](/build/manage-the-connections/reconnect-change-provider#disconnect-build-profile). +::: + + diff --git a/docs/build/platform-build-guides/_category_.json b/docs/build/platform-build-guides/_category_.json index 22465a060..ababf4c0f 100644 --- a/docs/build/platform-build-guides/_category_.json +++ b/docs/build/platform-build-guides/_category_.json @@ -1,6 +1,6 @@ { "label": "Platform Build Guides", - "position": 2, + "position": 4, "collapsed": true, "collapsible": true } diff --git a/docs/build/platform-build-guides/building-android-applications/_category_.json b/docs/build/platform-build-guides/building-android-applications/_category_.json index 9decc05ee..c0c605ec1 100644 --- a/docs/build/platform-build-guides/building-android-applications/_category_.json +++ b/docs/build/platform-build-guides/building-android-applications/_category_.json @@ -1,5 +1,5 @@ { - "label": "Building Android Applications", + "label": "Android Applications", "position": 2, "collapsed": true, "collapsible": true diff --git a/docs/build/platform-build-guides/building-android-applications/android-signing-for-google-play.md b/docs/build/platform-build-guides/building-android-applications/android-signing-for-google-play.md index d83d8e5e8..db66add90 100644 --- a/docs/build/platform-build-guides/building-android-applications/android-signing-for-google-play.md +++ b/docs/build/platform-build-guides/building-android-applications/android-signing-for-google-play.md @@ -11,24 +11,24 @@ import Screenshot from '@site/src/components/Screenshot'; # Android 11+ Signing for Google Play -As per Google's update on Android 11 behavior changes, there is an important (breaking) change regarding app signing +As per Google's update on Android 11 behavior changes, there is an important (breaking) change regarding app signing. https://developer.android.com/about/versions/11/behavior-changes-11#minimum-signature-scheme > Apps that target Android 11 (API level 30) that are currently only signed using APK Signature Scheme v1 must now also be signed using [APK Signature Scheme v2](https://source.android.com/security/apksigning/v2) or higher. Users can't install or update apps that are only signed with APK Signature Scheme v1 on devices that run Android 11. -In order to adapt your Application, you need to enable V2 Signing through either: +In order to adapt your application, you need to enable V2 signing through either: - Appcircle (Recommended) -- In your Project +- In your project ### Enable V2 Sign in Appcircle -In order to keep your config in Appcircle, you need to Navigate through: +In order to keep your config in Appcircle, you need to navigate through: -1. Your workflows -2. Select a workflow -3. Edit the **Android Sign** workflow +1. Your workflows. +2. Select a workflow. +3. Edit the **Android Sign** workflow. 4. Set V2 Sign to either **true** or **false**. @@ -45,7 +45,7 @@ Alternatively, you can use `build.gradle` instead to specify the signing you wil The current Android Sign step in Appcircle utilizes [jarsigner to sign apps](https://developer.android.com/studio/build/building-cmdline#bundle_build_gradle) with the APK Signature Scheme v1 and the alternative _apksigner_ cannot be used to sign app bundles (AAB). -The solution for this is to utilize signing in gradle within the app. A sample build.gradle file that utilizes APK Signature Scheme v2 can be found at [https://github.com/appcircleio/appcircle-sample-android/blob/v2-sign/app/build.gradle](https://github.com/appcircleio/appcircle-sample-android/blob/v2-sign/app/build.gradle) and the sample code can be seen below: +The solution for this is to utilize signing in Gradle within the app. A sample build.gradle file that utilizes APK Signature Scheme v2 can be found at [https://github.com/appcircleio/appcircle-sample-android/blob/v2-sign/app/build.gradle](https://github.com/appcircleio/appcircle-sample-android/blob/v2-sign/app/build.gradle) and the sample code can be seen below: @@ -108,7 +108,7 @@ You need to either sign with Appcircle Android Sign Step or via Gradle. If you'r :::info -If you're using **Gradle** to sign your APK file, you may need to add `v1SigningEnabled` and `v2SigningEnabled` to your signing configurations to install your APK file to both old and new Android versions. +If you're using **Gradle** to sign your APK file, you may need to add `v1SigningEnabled` and `v2SigningEnabled` to your signing configurations to install your APK file on both old and new Android versions. diff --git a/docs/build/platform-build-guides/building-android-applications/index.md b/docs/build/platform-build-guides/building-android-applications/index.md index d44c9a3c7..dd87c426d 100644 --- a/docs/build/platform-build-guides/building-android-applications/index.md +++ b/docs/build/platform-build-guides/building-android-applications/index.md @@ -8,7 +8,7 @@ import Screenshot from '@site/src/components/Screenshot'; import ContentRef from '@site/src/components/ContentRef'; import NeedHelp from '@site/docs/\_need-help.mdx'; -# Building Android Applications +# Android Applications @@ -28,7 +28,7 @@ First, we need to set up a build configuration. Select the configuration from th ### Private Modules -If your project uses private modules, don't forget the add necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. +If your project uses private modules, don't forget to add the necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. Connecting to Private Repository via SSH @@ -101,7 +101,7 @@ You can define variables and secrets to be incorporated during the build in the Please see the following page for more information about environment variables: - Why to Use Environment Variables and Secrets? + Why Use Environment Variables and Secrets? @@ -110,7 +110,7 @@ Please click on the Save button and close this modal. ### Workflow Editor -You can use the workflow editor for in-depth configuration of all build steps. Please click on the workflow icon to open and use workflow editor. +You can use the workflow editor for in-depth configuration of all build steps. Please click on the workflow icon to open and use the workflow editor. :::info @@ -126,17 +126,17 @@ For details on using Appcircle's workflow editor, please see the related page be You are now ready to start your first build. Select the branch from the left side and click on the **Start Build** button. - + -Select a configuration, workflow, commit id and click on **Start Build button** +Select a configuration, workflow, commit ID and click on **Start Build button** -Appcircle will start building your application. Build log window will open and you can follow build process in realtime. +Appcircle will start building your application. The build log window will open, and you can follow the build process in real time. :::info -You can safely close the build log window, it won't affect the status of your build. You can come back and click on the build to track the status of your build. +You can safely close the build log window; it won't affect the status of your build. You can come back and click on the build to track the status of your build. ::: @@ -150,7 +150,7 @@ Your build will be distributed automatically if you had set up Auto Distribute e ### chmod: cannot access './gradlew': No such file or directory -Every Android project has a `gradlew` file in the main repository directory. If the Android Build step can't find this file, you need to edit your workflow, find the Android Build Step and edit the `PROJECT PATH`. If your `gradlew` file is in the `android` folder, you need to write, `./android` in the edit box. +Every Android project has a `gradlew` file in the main repository directory. If the Android Build step can't find this file, you need to edit your workflow, find the Android Build Step, and edit the `PROJECT PATH`. If your `gradlew` file is in the `android` folder, you need to write, `./android` in the edit box. ### How can I change the JDK version for autofill? @@ -174,7 +174,7 @@ You can get the JDK home paths for each build pool from [Android's build infrast #### 2. Change `JAVA_HOME` using environment variables -You can use the [environment variables](/environment-variables/managing-variables) to enable the JDK version your project requires. +You can use the [environment variables](/build/build-environment-variables) to enable the JDK version your project requires. For example, you can take the following steps to change the default Java version to 17. @@ -197,11 +197,11 @@ You can get the JDK home paths for each build pool from [Android's build infrast > Could not GET 'https://jcenter.bintray.com/com/google/protobuf/protobuf-java-util/3.09.0/protobuf-java-util-3.09.0.pom'. Received status code 502 from server: Bad Gateway ``` -You may experience gradle build errors if your project uses Bintray resources. Since JFrog has shutdown Bintray on May 1, 2021. You should update your gradle file and move to Maven Central. Replace `jcenter()` with `mavenCentral()` in all your `build.gradle` files. Please be aware that some of your dependencies may not exist on Maven. +You may experience Gradle build errors if your project uses Bintray resources. Since JFrog has shut down Bintray on May 1, 2021. You should update your Gradle file and move to Maven Central. Replace `jcenter()` with `mavenCentral()` in all your `build.gradle` files. Please be aware that some of your dependencies may not exist on Maven. ### Gradle build daemon disappeared unexpectedly -If you receive a Gradle error similar to the following, it can happen due to 2 reasons +If you receive a Gradle error similar to the following, it can happen due to 2 reasons: ``` org.gradle.launcher.daemon.client.DaemonDisappearedException: Gradle build daemon disappeared unexpectedly (it may have been killed or may have crashed) @@ -220,11 +220,11 @@ java.lang.RuntimeException: java.lang.OutOfMemoryError: Java heap space - Problem with UTF-8 characters in your project or environment variable. Please edit your **gradle.properties** file and add `-Dfile.encoding=UTF-8` argument to `org.gradle.jvmargs` section. - You have edited **gradle.properties** and put some arguments to the `org.gradle.jvmargs` section. When you modify default JVM arguments, it resets the default `MaxMetaspaceSize` property. You should always add `-XX:MaxMetaspaceSize=256m` to this section to prevent unlimited memory allocation. -If you're using DexGuard, you may need to above modifications to your DexGuard configuration as well. +If you're using DexGuard, you may need to make the above modifications to your DexGuard configuration as well. ### I received a google-services.json Error but I don't want to push this file to the repository -Secret files such as the google-services.json can be added as a [secret environment variable](/environment-variables/managing-variables#adding-files-as-environment-variables) and then [selected in the build configuration](/build/build-process-management/build-profile-configuration#environment-variables-configuration). +Secret files such as the google-services.json can be added as a [secret environment variable](/build/build-environment-variables#adding-files-as-environment-variables) and then [selected in the build configuration](/build/build-process-management/configurations#environment-variables-configuration). Then, you can add a custom script step before the Android build step and move the file to the expected path during the build with a code like the following (where the secret environment variable is named as `GOOGLE_SERVICES_JSON`) : @@ -238,7 +238,7 @@ mv $GOOGLE_SERVICES_JSON $AC_REPOSITORY_DIR/app You may want to build unsigned Android applications. The most common mistake done with this is Appcircle users usually forget to disable the Sign Application step in the workflow.; -If you do not select a keystore in the build configuration, you need to disable the Sign Application step or your build will fail. +If you do not select a keystore in the build configuration, you need to disable the Sign Application step, or your build will fail. #### Keystore was tampered with or password was incorrect diff --git a/docs/build/platform-build-guides/building-dotnet-maui-apps.md b/docs/build/platform-build-guides/building-dotnet-maui-apps.md index 1bd93b0fa..af552b665 100644 --- a/docs/build/platform-build-guides/building-dotnet-maui-apps.md +++ b/docs/build/platform-build-guides/building-dotnet-maui-apps.md @@ -1,15 +1,15 @@ --- -title: Building .NET MAUI Apps +title: .NET MAUI Applications description: Learn how to build a .NET MAUI app on Appcircle tags: [build, platform build guides, MAUI, .NET MAUI, custom scripts] sidebar_position: 10 --- -# Building .NET MAUI Apps +# .NET MAUI Applications This guide gives necessary information about the steps that should be followed to successfully build and publish a [.NET MAUI](https://dotnet.microsoft.com/en-us/apps/maui) app with Appcircle. -It's an introduction to the basic steps such as build, code signing, and app publishing. Although these steps are minimum requirements for a mobile app build pipeline, you should go on with other sections of the Appcircle documentation for numerous advanced CI/CD features. +It's an introduction to the basic steps such as building, code signing, and app publishing. Although these steps are minimum requirements for a mobile app build pipeline, you should go on with other sections of the Appcircle documentation for numerous advanced CI/CD features. If you don't have a .NET MAUI app already or want to follow the steps quickly for a fast evaluation, you can use the [sample app](https://github.com/dotnet/maui-samples/tree/main/8.0/Apps/Calculator) Calculator from the `dotnet/maui-samples` repository. To simulate a .NET MAUI repository, it will be good to clone the app folder and add it as a repository to your own Git provider. @@ -55,7 +55,7 @@ Keep in mind that, in order to use iOS Signing Identities in the build pipeline, ::: -**4.** In the [build profile configuration](/build/build-process-management/build-profile-configuration), open the **Config** tab and edit the settings below. +**4.** In the [build profile configuration](/build/build-process-management/configurations#config-details), open the **Config** tab and edit the settings below. - **XCODE VERSION**: Select the Xcode version that's compatible with your app. For instance, `15.4.x`. You can take a look at the table [here](https://github.com/dotnet/maui/wiki/Release-Versions) for the compatible Xcode versions. - **XCODE PROJECT OR WORKSPACE PATH**: Enter the project or workspace file name. For instance, `Calculator.xcodeproj`. @@ -75,7 +75,7 @@ Intel-based runners are not supported or documented as of now, and you might nee ::: -**5.** In the [build profile configuration](/build/build-process-management/build-profile-configuration), open the **Signing** tab and **add provisioning profile** by selecting from the list of Signing Identities. +**5.** In the [build profile configuration](/build/build-process-management/configurations#config-details), open the **Signing** tab and **add provisioning profile** by selecting from the list of Signing Identities. :::caution @@ -83,7 +83,7 @@ Currently, **Automatic Code Signing** is not supported for iOS .NET MAUI builds. ::: -**6.** In your [workflow](/workflows), use the below custom script as a replacement of the default **Xcodebuild for Devices** step. +**6.** In your [workflow](/workflows), use the below custom script as a replacement for the default **Xcodebuild for Devices** step. :::info @@ -125,20 +125,20 @@ $dotnet publish $project -p:TargetFrameworks=$framework \ The custom script above does the following operations in order to build a .NET MAUI iOS app: -- Install .NET SDK -- Install `maui-ios` workload -- Build the project with dependencies -- Publish the app for deployment +- Install .NET SDK. +- Install `maui-ios` workload. +- Build the project with dependencies. +- Publish the app for deployment. The custom script has some **variables that should be changed or customized** for your pipeline. - **`dotnetVersion`**: You can select a .NET SDK version that's compatible with your project or solution. See [here](https://github.com/dotnet/maui/wiki/Release-Versions) for details. - **`framework`**: You should select a target framework that the app will be built for, considering your project requirements and .NET SDK version. See [here](https://learn.microsoft.com/en-us/dotnet/standard/frameworks) for details. - **`project`**: It should be the path to the project file for your app. `$AC_REPOSITORY_DIR` is a [reserved environment variable](/environment-variables/appcircle-specific-environment-variables) that should not be changed since it has the repository path value. You can change the rest of the path to customize it for your project structure. -- **`appleCertificate`**: You should use the certificate name as seen on the [Apple Certificates](/signing-identities/apple-certificates) list. It should also be compatible with the selected provisioning profile that you have selected from the [build profile configuration](/build/build-process-management/build-profile-configuration) **Signing** tab. -- **`appleProfile`**: It should be the name of the selected provisioning profile at the [build profile configuration](/build/build-process-management/build-profile-configuration) **Signing** tab. You can also see the name on the [Apple Profiles](/signing-identities/apple-profiles) list. +- **`appleCertificate`**: You should use the certificate name as seen on the [Apple Certificates](/signing-identities/apple-certificates) list. It should also be compatible with the selected provisioning profile that you have selected from the [build profile configuration](/build/build-process-management/configurations#config-details) **Signing** tab. +- **`appleProfile`**: It should be the name of the selected provisioning profile at the [build profile configuration](/build/build-process-management/configurations) **Signing** tab. You can also see the name on the [Apple Profiles](/signing-identities/apple-profiles) list. -When the build pipeline is completed successfully, you will see the signed `.ipa` in the [build artifacts](/build/post-build-operations/after-a-build#download-artifacts). +When the build pipeline is completed successfully, you will see the signed `.ipa` in the [build artifacts](/build/build-process-management/binary-actions#download-artifacts). #### References @@ -183,7 +183,7 @@ Keep in mind that, in order to use Android Signing Identities in the build pipel ::: -**5.** In the [build profile configuration](/build/build-process-management/build-profile-configuration), open the **Signing** tab and select your app's keystore from the list of Signing Identities. +**5.** In the [build profile configuration](/build/build-process-management/configurations), open the **Signing** tab and select your app's keystore from the list of Signing Identities. **6.** In your [workflow](/workflows), use the below **Custom Script** as a replacement of the default **Android Build** step. @@ -276,7 +276,7 @@ The custom script has some **variables that should be changed or customized** fo - **`project`**: It should be the path to the project file for your app. `$AC_REPOSITORY_DIR` is a [reserved environment variable](/environment-variables/appcircle-specific-environment-variables) that should not be changed since it has the repository path value. You can change the rest of the path to customize it for your project structure. - **`packageFormat`**: A semi-colon delimited property that indicates if you want to package the app as an APK file or AAB. Set to either `aab` or `apk` to generate only one format. -When the build pipeline is completed successfully, you will see the signed `.apk` or `.aab` in the [build artifacts](/build/post-build-operations/after-a-build#download-artifacts). +When the build pipeline is completed successfully, you will see the signed `.apk` or `.aab` in the [build artifacts](/build/build-process-management/binary-actions#download-artifacts). :::info @@ -286,7 +286,7 @@ You can also use the **Signing Identities** from Appcircle when you are signing Keep in mind that, if you sign your app with the `dotnet publish`, you will not need the **Android Sign** step in your workflow. So, you should disable it or remove it from your workflow. -Also, change the output directory (`-o|--output`) to `$AC_OUTPUT_DIR` to send the signed artifacts directly to the [build artifacts](/build/post-build-operations/after-a-build#download-artifacts). +Also, change the output directory (`-o|--output`) to `$AC_OUTPUT_DIR` to send the signed artifacts directly to the [build artifacts](/build/build-process-management/binary-actions#download-artifacts). ::: diff --git a/docs/build/platform-build-guides/building-flutter-applications/_category_.json b/docs/build/platform-build-guides/building-flutter-applications/_category_.json index 10ea349eb..118c551f7 100644 --- a/docs/build/platform-build-guides/building-flutter-applications/_category_.json +++ b/docs/build/platform-build-guides/building-flutter-applications/_category_.json @@ -1,5 +1,5 @@ { - "label": "Building Flutter Applications", + "label": "Flutter Applications", "position": 4, "collapsed": true, "collapsible": true diff --git a/docs/build/platform-build-guides/building-flutter-applications/building-flutter-applications.md b/docs/build/platform-build-guides/building-flutter-applications/building-flutter-applications.md index caf5faf60..65a717f4c 100644 --- a/docs/build/platform-build-guides/building-flutter-applications/building-flutter-applications.md +++ b/docs/build/platform-build-guides/building-flutter-applications/building-flutter-applications.md @@ -1,5 +1,5 @@ --- -title: Building Flutter Mobile Applications +title: Flutter Mobile Applications description: You can build your Flutter applications in Appcircle for iOS or Android platforms. tags: [build, platform build guides, flutter] sidebar_position: 7 @@ -10,7 +10,7 @@ import ContentRef from '@site/src/components/ContentRef'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Building Flutter Mobile Applications +# Flutter Mobile Applications You can build your Flutter applications in Appcircle for iOS or Android platforms. @@ -34,7 +34,7 @@ Build configuration options are very similar to native iOS or Android applicatio ### Private Modules -If your project uses private modules, don't forget the add necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. +If your project uses private modules, don't forget to add the necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. Connecting to Private Repository via SSH @@ -60,13 +60,13 @@ First, we need to set up a build configuration. Select the configuration from th ### Build Configuration for Flutter Web applications -Flutter Web apps are built alongside with iOS or Android Flutter apps. For more information please refer to the following guide: +Flutter Web apps are built alongside iOS or Android Flutter apps. For more information, please refer to the following guide: Building Flutter Web Applications ### Sending the Build Status to the Repository Providers -At the bottom of the config tab, you will the **Set Commit Build Status **option. +At the bottom of the config tab, you will see the **Set Commit Build Status **option. @@ -129,7 +129,7 @@ The final tab is to add environment variables to the build. For advanced use cas Please refer to the following document for more information on environment variables: - Why to Use Environment Variables and Secrets? + Why Use Environment Variables and Secrets? ### Build Workflows for Flutter Applications @@ -148,15 +148,15 @@ To change the Flutter version, open the Flutter Install workflow step from the w -You can also set the preferred Flutter version on config screen. If you don't set any version, `stable` version will be used. +You can also set the preferred Flutter version on the config screen. If you don't set any version, `stable` version will be used. ### Starting a Flutter Build and After a Build -You are now ready to start your first build. Select the branach from the left side and click on the **Start Build** button. +You are now ready to start your first build. Select the branch from the left side and click on the **Start Build** button. - + -Select a configuration, workflow, commit id and click on **Start Build button** +Select a configuration, workflow, and commit ID and click on **Start Build button** @@ -191,7 +191,7 @@ brew install dart ### Flutter release mode binaries do not work on the Android emulator -To run a Flutter release mode APK in an emulator, please make sure that the emulator runs with the `x86_64` ABI type and the app are configured accordingly. Emulators with `x86` ABI type are not supported by Flutter . (Please refer to the following GitHub issue on the Flutter repository for more information: [https://github.com/flutter/flutter/issues/28432](https://github.com/flutter/flutter/issues/28432)) +To run a Flutter release mode APK in an emulator, please make sure that the emulator runs with the `x86_64` ABI type and the app is configured accordingly. Emulators with `x86` ABI type are not supported by Flutter . (Please refer to the following GitHub issue on the Flutter repository for more information: [https://github.com/flutter/flutter/issues/28432](https://github.com/flutter/flutter/issues/28432)) ### No pubspec.yaml file found error @@ -201,7 +201,7 @@ For reference, please refer to the [Android Flutter Build](https://github.com/ap ### File not found error -You may get an error like below when you're building an Android project. +You may get an error like the one below when you're building an Android project. ``` lib/src/core/dependency/myservice.dart:12:8: Error: Error when reading ‘lib/src/data/repositories/CustomerRepository.dart’: No such file or directory @@ -245,15 +245,15 @@ You have either: **Suggested resolution** -- Option 1 (recommended): Run `pod update Amplify AWSPluginsCore AmplifyPlugins` from the ios dir. This will update the pods that are used by the amplify flutter packages. -- Option 2: Delete the `Podfile.lock` (in the ios dir) and rebuild. A new Podfile.lock will be generated. Please note, this may cause other non amplify related dependencies to be updated as well. -- Option 3: Run pod update from the ios dir. This should update your `Podfile.lock` file. Please note, this may cause other non amplify related dependencies to be updated as well. +- Option 1 (recommended): Run `pod update Amplify AWSPluginsCore AmplifyPlugins` from the iOS dir. This will update the pods that are used by the amplify flutter packages. +- Option 2: Delete the `Podfile.lock` (in the iOS dir) and rebuild. A new Podfile.lock will be generated. Please note, this may cause other non amplify related dependencies to be updated as well. +- Option 3: Run pod update from the iOS dir. This should update your `Podfile.lock` file. Please note, this may cause other non amplify related dependencies to be updated as well. ### Cocoapods Error `Signing for "MyPod" requires a development team. Select a development team in the Signing & Capabilities editor` -If you are using Xcode 14 and your Flutter version is less than 3.3, your build may fail with above message. You should modify your Podfile according to below snippet. Flutter 3.3 fixes this bug. [Related Flutter Issue](https://github.com/flutter/flutter/issues/111757) +If you are using Xcode 14 and your Flutter version is less than 3.3, your build may fail with the above message. You should modify your Podfile according to the below snippet. Flutter 3.3 fixes this bug. [Related Flutter Issue](https://github.com/flutter/flutter/issues/111757) ```ruby post_install do |installer| diff --git a/docs/build/platform-build-guides/building-flutter-applications/building-flutter-web-applications.md b/docs/build/platform-build-guides/building-flutter-applications/building-flutter-web-applications.md index e7920a15d..e24a2d490 100644 --- a/docs/build/platform-build-guides/building-flutter-applications/building-flutter-web-applications.md +++ b/docs/build/platform-build-guides/building-flutter-applications/building-flutter-web-applications.md @@ -1,5 +1,5 @@ --- -title: Building Flutter Web Applications +title: Flutter Web Applications description: You can build your Flutter web applications in Appcircle. tags: [flutter, web, flutter web, flutter web build] sidebar_position: 8 @@ -10,7 +10,7 @@ import ContentRef from '@site/src/components/ContentRef'; import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -# Building Flutter Web Applications +# Flutter Web Applications If your app supports Flutter Web, you can also build the Flutter web app along with the [Flutter iOS or Android build](/build/platform-build-guides/building-flutter-applications). @@ -18,7 +18,7 @@ With Appcircle, you can manage your entire Flutter build workflows both for mobi Flutter Web Build is available as a workflow step in the workflow marketplace. Just configure your project as you would for iOS or Android and add the Flutter Build for Web step anywhere after the Flutter Install step to include a web build in the workflow. - + If you want to build your Flutter project only for the web, you can [add a Flutter Android project in the standard way](/build/platform-build-guides/building-flutter-applications), save your project configuration once, and then remove all the Android-related steps from the build workflow. @@ -32,19 +32,19 @@ In this case, after removing Android-related steps, the workflow will look like -For more information about workflows, refer the workflow documentation below: +For more information about workflows, refer to the workflow documentation below: What are Workflows If you want to deploy your web output automatically, you can use a [Custom Script](https://github.com/appcircleio/appcircle-custom-script-component/) or [upload it to Amazon S3](/workflows/common-workflow-steps/upload-files-to-amazon-s3). -Once your build is configured, it can be built [manually or automatically in the same way with other apps](/build/build-process-management/build-manually-or-with-triggers). With Flutter 2.0, you can build your Flutter web apps in the stable channel. (In Flutter 1.x, it was necessary to use the beta channel.) +Once your build is configured, it can be built [manually or automatically in the same way as other apps](/build/build-process-management/build-manually-or-with-triggers). With Flutter 2.0, you can build your Flutter web apps in the stable channel. (In Flutter 1.x, it was necessary to use the beta channel.) After a build, you can download the web build output manually [from the build artifact list](/build/platform-build-guides/building-flutter-applications#starting-a-flutter-build-and-after-a-build) as the `web.zip` file. - + :::info diff --git a/docs/build/platform-build-guides/building-ionic-projects-with-custom-scripts.md b/docs/build/platform-build-guides/building-ionic-projects-with-custom-scripts.md index 3c46a093c..10a098674 100644 --- a/docs/build/platform-build-guides/building-ionic-projects-with-custom-scripts.md +++ b/docs/build/platform-build-guides/building-ionic-projects-with-custom-scripts.md @@ -1,21 +1,21 @@ --- -title: Building Ionic Projects with Custom Scripts +title: Ionic Projects description: Learn how to build Ionic projects with custom scripts in Appcircle tags: [build, platform build guides, ionic, custom scripts] sidebar_position: 9 --- -# Building Ionic Projects with Custom Scripts +# Ionic Projects with Custom Scripts Appcircle provides Ionic projects through custom scripts. You can use the following project as an example for running Ionic builds in Appcircle:[ https://github.com/appcircleio/appcircle-sample-ionic](https://github.com/appcircleio/appcircle-sample-ionic) -The sample project is built with Vue though other Ionic project types can also be built in a similar manner. For the build, Capacitor is recommended and this document is based on projects configured to be built with Capacitor in Android Studio or Xcode. +The sample project is built with Vue though other Ionic project types can also be built in a similar manner. For the build, Capacitor is recommended, and this document is based on projects configured to be built with Capacitor in Android Studio or Xcode. To build an Ionic project, first, add and configure it like a [React Native project](building-react-native-applications). -One important point to take note is that `capacitor-cordova-android-plugins` folder is automatically added to .gitignore file, but it is required during the build. The folder can be removed from the .gitignore or it can be regenerated during the build; though the former is recommended for a successful [Fetch](/build/build-process-management/build-profile-configuration/#project-details-configuration)) operation. For more information, you can refer to the following Git issue for Capacitor: [https://github.com/ionic-team/capacitor/issues/1628](https://github.com/ionic-team/capacitor/issues/1628) +One important point to take note of is that `capacitor-cordova-android-plugins` folder is automatically added to the .gitignore file, but it is required during the build. The folder can be removed from the .gitignore or it can be regenerated during the build, though the former is recommended for a successful [Fetch](/build/build-process-management/configurations#config-details) operation. For more information, you can refer to the following Git issue for Capacitor: [https://github.com/ionic-team/capacitor/issues/1628](https://github.com/ionic-team/capacitor/issues/1628) You can then add the custom scripts before the build steps and run the build normally. diff --git a/docs/build/platform-build-guides/building-ios-applications.md b/docs/build/platform-build-guides/building-ios-applications.md index 22a1c3405..3c1a900d8 100644 --- a/docs/build/platform-build-guides/building-ios-applications.md +++ b/docs/build/platform-build-guides/building-ios-applications.md @@ -1,5 +1,5 @@ --- -title: Building iOS Applications +title: iOS Applications description: Building iOS applications may be complex and confusing. Appcircle will help you smooth the process and doesn't require any additional configuration files from you. tags: [build, platform build guides, ios, faq] sidebar_position: 1 @@ -8,7 +8,7 @@ sidebar_position: 1 import Screenshot from '@site/src/components/Screenshot'; import ContentRef from '@site/src/components/ContentRef'; -# Building iOS Applications +# iOS Applications @@ -48,7 +48,7 @@ Please don't forget to add additional scheme files to your version control. ### Private Modules -If your project uses private modules, don't forget the add necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. +If your project uses private modules, don't forget to add the necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. Connecting to Private Repository via SSH @@ -58,7 +58,7 @@ https://github.com/appcircleio/appcircle-netrc-component #### Selecting the Xcode Version and Switching to the Xcode Beta -Major Xcode versions are available for building in Appcircle. You can select the preferred Xcode version in Build Configuration window. +Major Xcode versions are available for building in Appcircle. You can select the preferred Xcode version in the Build Configuration window. The list of currently available Xcode versions can be found in the following document: [iOS Build Infrastructure](/infrastructure/ios-build-infrastructure) @@ -92,8 +92,6 @@ You can visit the following page for details on build triggers: Build Manually or Automatically with Webhooks and Triggers -### - ### Signing The next step on build configuration is Signing. Here, please select the provisioning profile you added at [Apple Certificates & Provisioning Profiles](/signing-identities) page. @@ -108,7 +106,7 @@ You can get both unsigned and signed build artifacts based on your configuration ### Distribution -The next step on build configuration is Distribution. You can create a new distribution profile at this screen or select a previous profile you created earlier. You can also enable auto deployment features if you need to. +The next step on build configuration is Distribution. You can create a new distribution profile on this screen or select a previous profile you created earlier. You can also enable auto deployment features if you need to. Create a Distribution Profile and Sharing with Testers @@ -132,14 +130,14 @@ The versioning tab will allow you to change the build or version number during t The final step on build configuration is Environment Variables. -Appcircle Build module is simple and powerful. You can get your builds instantly just with a few clicks, advanced management of builds is also possible with the environment variables and workflows. +Appcircle Build module is simple and powerful. You can get your builds instantly just with a few clicks; advanced management of builds is also possible with the environment variables and workflows. You can define variables and secrets to be incorporated during the build in the Environment Variables submodule so that you don't need to store certain keys and configurations within the repository. Please see the following page for more information about environment variables: - Why to Use Environment Variables and Secrets? + Why Use Environment Variables and Secrets? @@ -148,11 +146,11 @@ Please click on the Save button and close this modal. ### Workflow Editor -You can use the workflow editor for in-depth configuration of all build steps. Please click on the workflow icon to open and use workflow editor. +You can use the workflow editor for in-depth configuration of all build steps. Please click on the workflow icon to open and use the workflow editor. :::info -Any custom operation during the build can be executed through the Custom Script step in the workflow +Any custom operation during the build can be executed through the Custom Script step in the workflow. ::: @@ -162,19 +160,19 @@ For details on using Appcircle's workflow editor, please see the related page be ### Start Build -You are now ready to start your first build. Select the branach from the left side and click on the **Start Build** button. +You are now ready to start your first build. Select the branch from the left side and click on the **Start Build** button. - + Select a configuration, workflow, commit id and click on **Start Build button** -Appcircle will start building your application. Build log window will open and you can follow build process in realtime. +Appcircle will start building your application. The build log window will open, and you can follow build process in real time. :::info -You can safely close the build log window, it won't affect the status of your build. You can come back and click on the build to track the status of your build. +You can safely close the build log window; it won't affect the status of your build. You can come back and click on the build to track the status of your build. ::: @@ -188,18 +186,18 @@ Your build will be distributed automatically if you had set up auto build earlie After a Build - + ## FAQ ### Xcode Scheme Errors -Your iOS application project needs to have a shared scheme in order to be built outside Xcode. Xcode doesn't share schemes by default so you will have to do it manually. +Your iOS application project needs to have a shared scheme in order to be built outside Xcode. Xcode doesn't share schemes by default, so you will have to do it manually. 1. On Xcode, select **Product** > **Scheme** > **Manage Schemes** 2. Select **Shared** for your `xcproject` or `xcworkspace` -3. Scheme container needs to be set to the corresponding Xcode project or workspace -4. Please do not forget to add your `.xcscheme` file to version control so it will be uploaded to your Git repository +3. The scheme container needs to be set to the corresponding Xcode project or workspace. +4. Please do not forget to add your `.xcscheme` file to version control so it will be uploaded to your Git repository. ### Cocoapods Errors Due to Missing xcworkspace @@ -207,7 +205,7 @@ If you receive a pod error similar to the following, this usually indicates that `error: .../_appcircle_temp/Repository/Obj-C/Pods/Target Support Files/Pods-AEPSampleAppObjC/Pods-AEPSampleAppObjC.release.xcconfig: unable to open file (in target "AEPSampleAppObjC" in project "AEPSampleAppObjC") (in target 'AEPSampleAppObjC' from project 'AEPSampleAppObjC')` -If a pod is used, the xcworkspace must be pushed to the repository and it must be selected in the build configuration for a successful build. +If a pod is used, the xcworkspace must be pushed to the repository, and it must be selected in the build configuration for a successful build. If you don't want to push the xcworkspace to the repository, you can alternatively enter the xcworkspace path manually in the build configuration. In this case, the xcworkspace will be generated by the Cocapods workflow component. @@ -219,7 +217,7 @@ If you don't set the version of Cocoapods in your Cocoapods Install step, Appcir After the release of Xcode 15, some notable known issues have surfaced. One of them is the `DT_TOOLCHAIN_DIR cannot be used to evaluate` error. -When encountering this error, you will see the following log durint the Xcodebuild for Devices step; +When encountering this error, you will see the following log during the Xcode build for Devices step; ``` DT_TOOLCHAIN_DIR cannot be used to evaluate LIBRARY_SEARCH_PATHS, use TOOLCHAIN_DIR instead (in target 'One of Project Target Name' from project 'Pods') @@ -349,7 +347,7 @@ post_install do |installer| end end ``` -2. Skip signing pod bundles +2. Skip signing pod bundles. ```ruby post_install do |installer| @@ -367,7 +365,7 @@ end ``` ### iOS Minimum Deployment Target Error -Following the release of new Xcode and iOS versions, projects containing pods or targets below certain iOS versions may experience simulator-related errors due to unsupported older iOS versions. +Following the release of new Xcode, and iOS versions, projects containing pods or targets below certain iOS versions may experience simulator-related errors due to unsupported older iOS versions. During the 'Xcodebuild for Devices' step, you may encounter an error similar to this: diff --git a/docs/build/platform-build-guides/building-react-native-applications.md b/docs/build/platform-build-guides/building-react-native-applications.md index dfddfac54..419049196 100644 --- a/docs/build/platform-build-guides/building-react-native-applications.md +++ b/docs/build/platform-build-guides/building-react-native-applications.md @@ -1,5 +1,5 @@ --- -title: Building React Native Applications +title: React Native Applications description: You can build your React Native applications in Appcircle for iOS or Android platforms. tags: [build, platform build guides, react native, faq] sidebar_position: 3 @@ -8,7 +8,7 @@ sidebar_position: 3 import Screenshot from '@site/src/components/Screenshot'; import ContentRef from '@site/src/components/ContentRef'; -# Building React Native Applications +# React Native Applications You can build your React Native applications in Appcircle for iOS or Android platforms. @@ -32,11 +32,11 @@ Once your build profile is created, click on it and connect your Git repository. ### Build Configuration for React Native Applications -Build configuration options are very similar to native iOS or Android applications. You can select configuration details, build triggers, signing identities and distribution options. +Build configuration options are very similar to native iOS or Android applications. You can select configuration details, build triggers, signing identities, and distribution options. ### Private Modules -If your project uses private modules, don't forget the add necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. +If your project uses private modules, don't forget to add the necessary SSH keys to your workflow steps. You can use `Activate SSH Private Key` step to add your private SSH keys. Connecting to Private Repository via SSH @@ -74,7 +74,7 @@ First, we need to set up a build configuration. Select the configuration from th ### Sending the Build Status to the Repository Providers -At the bottom of the config tab, you will the **Set Commit Build Status **option. +At the bottom of the config tab, you will see the **Set Commit Build Status **option. @@ -86,7 +86,7 @@ When this option is enabled, the build status for that commit is shared with the ### Build Triggers -Triggers, is common for both iOS and Android. +Triggers is common for both iOS and Android. Appcircle allows you to trigger builds manually or automatically using build triggers. @@ -154,9 +154,9 @@ To learn more about Appcircle's Workflow editor, see the corresponding page belo ### Starting a React Native Build and After a Build -To start your first build, just press the start build button – the play button under the actions columns (or push some code to your repo if autobuild is configured.) You will see the build progress and the log in realtime. +To start your first build, just press the start build button – the play button under the actions columns (or push some code to your repo if autobuild is configured.) You will see the build progress and the log in real time. -Once your build is complete, you can now download the binary file or deploy it to Testing Distribution manually (if autodistribute is enabled, it will be sent automatically after a successful build). You can also view or download your build logs at anytime. +Once your build is complete, you can now download the binary file or deploy it to Testing Distribution manually (if autodistribute is enabled, it will be sent automatically after a successful build). You can also view or download your build logs at any time. After a Build @@ -164,7 +164,7 @@ Once your build is complete, you can now download the binary file or deploy it t ### ERR_OSSL_EVP_UNSUPPORTED -If you receive an error similar to the following, it’s likely that your application or a module you’re using is attempting to use an algorithm or key size which is no longer allowed by default with OpenSSL 3.0. +If you receive an error similar to the following, it’s likely that your application or a module you’re using is attempting to use an algorithm or key size that is no longer allowed by default with OpenSSL 3.0. ``` opensslErrorStack: [ 'error:03000086:digital envelope routines::initialization error' ], @@ -180,7 +180,7 @@ You can either add the command-line option, `--openssl-legacy-provider` to your If you face problems during NPM/Yarn install steps on Appcircle but not on your local machine, you should confirm the following steps: - [x] Make sure that your packages support the node version you use. -- [x] Make sure that the file interactions that is done on `preinstall` and/or `postinstall` scrips are suitable to be executed on a different machine +- [x] Make sure that the file interactions that is done on `preinstall` and/or `postinstall` scrips are suitable to be executed on a different machine. #### Queries to registry.yarnpkg.com return a `404/500/...` @@ -192,7 +192,7 @@ On the other hand, yarn modern (2.x) has stability improvements that can fix the Upgrading to the latest versions is critical to a fast and stable yarn experience. So, if you're getting these kinds of errors in your build pipeline, we recommend upgrading your yarn version. -You can see the steps to do upgrade in the following section. 👇 +You can see the steps to do the upgrade in the following section. 👇 #### Upgrading From Yarn 1 to Yarn 2 in Pipeline @@ -206,7 +206,7 @@ yarn --version yarn config set -H enableImmutableInstalls false ``` -When you run the pipeline again with an up-to-date workflow, you should see the upgraded yarn version in your build logs. +When you run the pipeline again with an up-to-date workflow, you should see the upgraded Yarn version in your build logs. ### Disable Flipper SDK on iOS @@ -225,7 +225,7 @@ Example Podfile modification: :::tip -Appcircle uses the lts(Long Term Support) node version by default. +Appcircle uses the LTS (Long Term Support) node version by default. ::: diff --git a/docs/build/platform-build-guides/building-xamarin-apps.md b/docs/build/platform-build-guides/building-xamarin-apps.md index bb40236c4..bea2864a7 100644 --- a/docs/build/platform-build-guides/building-xamarin-apps.md +++ b/docs/build/platform-build-guides/building-xamarin-apps.md @@ -1,15 +1,15 @@ --- -title: Building Xamarin Apps +title: Xamarin Applications description: Learn how to build a Xamarin app on Appcircle tags: [build, platform build guides, .net, xamarin, custom scripts] sidebar_position: 10 --- -# Building Xamarin Apps +# Xamarin Applications This guide gives necessary information about the steps that should be followed to successfully build and publish a [Xamarin](https://dotnet.microsoft.com/en-us/apps/xamarin) app with Appcircle. -It's an introduction to the basic steps such as build, code signing, and app publishing. Although these steps are minimum requirements for a mobile app build pipeline, you should go on with other sections of the Appcircle documentation for numerous advanced CI/CD features. +It's an introduction to the basic steps such as building, code signing, and app publishing. Although these steps are minimum requirements for a mobile app build pipeline, you should go on with other sections of the Appcircle documentation for numerous advanced CI/CD features. If you don't have a Xamarin app already or want to follow the steps quickly for a fast evaluation, you can use the [sample app](https://github.com/appcircleio/appcircle-sample-xamarin) repository. To simulate a Xamarin repository, it will be good to clone the app folder and add it as a repository to your own Git provider. @@ -53,7 +53,7 @@ Keep in mind that, in order to use iOS Signing Identities in the build pipeline, ::: -**4.** In the [Build Profile Configuration](/build/build-process-management/build-profile-configuration), open the **Config** tab and edit the settings below. +**4.** In the [Build Profile Configuration](/build/build-process-management/configurations), open the **Config** tab and edit the settings below. - **XCODE VERSION**: Select the Xcode version that's compatible with your app. For instance, `14.3.x`. - **XCODE PROJECT OR WORKSPACE PATH**: The custom script we will use does not require a valid Xcode project path. If you haven't exported your Xamarin project to Xcode yet, you can provide a temporary path. For instance, `temp.xcodeproj`. @@ -73,7 +73,7 @@ Intel-based runners are not supported or documented as of now, and you might nee ::: -**5.** In the [Build Profile Configuration](/build/build-process-management/build-profile-configuration), open the **Signing** tab and **add provisioning profile** by selecting from the list of Signing Identities. +**5.** In the [Build Profile Configuration](/build/build-process-management/configurations#config-details), open the **Signing** tab and **add provisioning profile** by selecting from the list of Signing Identities. :::caution @@ -138,10 +138,10 @@ msbuild $IOS_PROJECT_DIR /t:Build /p:Configuration=Release /p:Platform=iPhone /p The custom script above does the following operations in order to build a Xamarin iOS app: - Install [Mono](https://www.mono-project.com/) -- Install .NET SDK -- Install Xamarin iOS SDK -- Build the project with dependencies -- Publish the app for deployment +- Install .NET SDK. +- Install Xamarin iOS SDK. +- Build the project with dependencies. +- Publish the app for deployment. The custom script has some **variables that should be changed or customized** for your pipeline. @@ -150,10 +150,10 @@ The custom script has some **variables that should be changed or customized** fo - **`XAMARIN_IOS_SDK_DOWNLOAD_URL`**: The download link for the Xamarin iOS SDK version you want to install. Copy the link for the version from [here](https://github.com/xamarin/xamarin-macios/blob/main/DOWNLOADS.md). - **`PROJECT_ROOT_DIR`**: The location of your `.sln` file. Your Git repository is typically saved within the `$AC_REPOSITORY_DIR` inside the runner. However, your .sln file may be located in a subdirectory of this folder. Please specify this. For instance, `$AC_REPOSITORY_DIR/src` - **`IOS_PROJECT_DIR`**: The location of the `.csproj` file is required for performing iOS-specific builds. In this script, it is `AppcircleXamarin.iOS/AppcircleXamarin.iOS.csproj`. -- **`APPLE_CERTIFICATE_NAME`**: You should use the certificate name as seen on the [Apple Certificates](/signing-identities/apple-certificates) list. It should also be compatible with the selected provisioning profile that you have selected from the [Build Profile Configuration](/build/build-process-management/build-profile-configuration) **Signing** tab. -- **`APPLE_PROFILE_NAME`**: It should be the name of the selected provisioning profile at the [Build Profile Configuration](/build/build-process-management/build-profile-configuration) **Signing** tab. You can also see the name on the [Apple Profiles](/signing-identities/apple-profiles) list. +- **`APPLE_CERTIFICATE_NAME`**: You should use the certificate name as seen on the [Apple Certificates](/signing-identities/apple-certificates) list. It should also be compatible with the selected provisioning profile that you have selected from the [Build Profile Configuration](/build/build-process-management/configurations) **Signing** tab. +- **`APPLE_PROFILE_NAME`**: It should be the name of the selected provisioning profile at the [Build Profile Configuration](/build/build-process-management/configurations) **Signing** tab. You can also see the name on the [Apple Profiles](/signing-identities/apple-profiles) list. -When the build pipeline is completed successfully, you will see the signed `.ipa` in the [build artifacts](/build/post-build-operations/after-a-build#download-artifacts). +When the build pipeline is completed successfully, you will see the signed `.ipa` in the [build artifacts](/build/build-process-management/binary-actions#download-artifacts). ### Xamarin Build for Android @@ -188,7 +188,7 @@ Keep in mind that, in order to use Android Signing Identities in the build pipel ::: -**5.** In the [Build Profile Configuration](/build/build-process-management/build-profile-configuration), open the **Signing** tab and select your app's keystore from the list of Signing Identities. +**5.** In the [Build Profile Configuration](/build/build-process-management/configurations), open the **Signing** tab and select your app's keystore from the list of Signing Identities. **6.** In your [workflow](/workflows), use the below **Custom Script** as a replacement of the default **Android Build** step. Remove the **Android App Post-Processor** and **Increment Build and Version Number** steps from your workflow. @@ -292,7 +292,7 @@ The custom script has some **variables that should be changed or customized** fo - **`ANDROID_PROJECT_DIR`**: The location of the `.csproj` file is required for performing iOS-specific builds. In this script, it is `AppcircleXamarin.Android/AppcircleXamarin.Android.csproj`. - **`ANDROID_PACKAGE_FORMAT`**: Please specify the type of your application package. It can be either `apk` or `aab`. -When the build pipeline is completed successfully, you will see the signed `.apk` or `.aab` in the [build artifacts](/build/post-build-operations/after-a-build#download-artifacts). +When the build pipeline is completed successfully, you will see the signed `.apk` or `.aab` in the [build artifacts](/build/build-process-management/binary-actions#download-artifacts). ### Next Steps diff --git a/docs/build/platform-build-guides/index.md b/docs/build/platform-build-guides/index.md index 1e48b9212..41f967556 100644 --- a/docs/build/platform-build-guides/index.md +++ b/docs/build/platform-build-guides/index.md @@ -21,31 +21,31 @@ tags: Find detailed instructions on building applications for various platforms using Appcircle: -### [Building iOS Applications](/build/platform-build-guides/building-ios-applications) +### [iOS Applications](/build/platform-build-guides/building-ios-applications) Comprehensive guide for setting up iOS app builds, from provisioning to distribution. -### [Building Android Applications](/build/platform-build-guides/building-android-applications) +### [Android Applications](/build/platform-build-guides/building-android-applications) Step-by-step instructions on how to configure and optimize the Android build process. -### [Building React Native Applications](/build/platform-build-guides/building-react-native-applications) +### [React Native Applications](/build/platform-build-guides/building-react-native-applications) Tailored guidance for building React Native apps, covering both iOS and Android builds. -### [Building Flutter Applications](/build/platform-build-guides/building-flutter-applications) +### [Flutter Applications](/build/platform-build-guides/building-flutter-applications) Everything you need to know to build Flutter applications for multiple platforms. -### [Building Ionic Projects with Custom Scripts](/build/platform-build-guides/building-ionic-projects-with-custom-scripts) +### [Ionic Projects](/build/platform-build-guides/building-ionic-projects-with-custom-scripts) Learn how to use custom scripts to build and customize Ionic projects for any requirements. -### [Building .NET MAUI Apps](/build/platform-build-guides/building-dotnet-maui-apps) +### [.NET MAUI Applications](/build/platform-build-guides/building-dotnet-maui-apps) Learn how to use custom scripts to build and customize .NET MAUI apps on Appcircle. -### [Building Xamarin Apps](/build/platform-build-guides/building-xamarin-apps) +### [Xamarin Applications](/build/platform-build-guides/building-xamarin-apps) Learn how to use custom scripts to build and customize Xamarin apps on Appcircle. @@ -55,7 +55,7 @@ Learn how to use custom scripts to build and customize Xamarin apps on Appcircle There may be a bunch of reasons for a build to fail. -The best way to learn the reason is to check the build logs. See [**Working With Build Logs**](/build/post-build-operations/after-a-build#working-with-build-logs) section for details on this. +The best way to learn the reason is to check the build logs. See [**Working With Build Logs**](/build/build-process-management/binary-actions#working-with-build-logs) section for details on this. Build logs will display everything that happened in each workflow step in detail and let you examine what went wrong during the build. @@ -63,11 +63,11 @@ If you are unable to determine the exact cause, feel free to get in touch with A ### Troubleshooting Workflow Steps for Build Failures -Most build failures are related with the following build steps. If you encounter any errors, [please remove or edit the following steps](/workflows) and get a build to help isolate the cause of the issue. +Most build failures are related to the following build steps. If you encounter any errors, [please remove or edit the following steps](/workflows) and get a build to help isolate the cause of the issue. -- **iOS Sign Errors:** If the selected provisioning profile does not match with the selected bundle ID or if the certificate is not valid, you may have an issue in the iOS signing step. In this case, you may try getting an unsigned build -- **Xcode Build for Simulator step:** This step builds your target for either x86_64 or arm64 architecture. In some projects, there may be dependencies that are not compatible with given architecture. In this case, please remove this step from the workflow or remove the conflicting dependencies to get a successful build. -- **Android Sign Errors:** If you encounter errors while signing your Android app, you can remove this step to get an unsigned build or you can configure the app signing within your project. +- **iOS Sign Errors:** If the selected provisioning profile does not match with the selected bundle ID or if the certificate is not valid, you may have an issue in the iOS signing step. In this case, you may try getting an unsigned build. +- **Xcode Build for Simulator step:** This step builds your target for either x86_64 or arm64 architecture. In some projects, there may be dependencies that are not compatible with the given architecture. In this case, please remove this step from the workflow or remove the conflicting dependencies to get a successful build. +- **Android Sign Errors:** If you encounter errors while signing your Android app, you can remove this step to get an unsigned build, or you can configure the app signing within your project. ### The Build is Taking Too Long diff --git a/docs/build/post-build-operations/_category_.json b/docs/build/post-build-operations/_category_.json deleted file mode 100644 index 7c4e41205..000000000 --- a/docs/build/post-build-operations/_category_.json +++ /dev/null @@ -1,6 +0,0 @@ -{ - "label": "Post-Build Operations", - "position": 4, - "collapsed": true, - "collapsible": true -} diff --git a/docs/build/post-build-operations/index.md b/docs/build/post-build-operations/index.md deleted file mode 100644 index 22cb57ec2..000000000 --- a/docs/build/post-build-operations/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: Post-Build Operations -description: Maximize the efficiency of your build process with Appcircle's post-build features. Access and manage build artifacts, logs, and other outputs with ease. -tags: - [ - post build operations, - build artifacts, - build logs, - build outputs, - app development, - app deployment, - appcircle post-build, - ] ---- - -# Post-Build Operations - -Maximize the efficiency of your build process by leveraging Appcircle's post-build features: - -- [**Build Actions**](/build/post-build-operations/after-a-build): With Appcircle's post-build actions, you can easily distribute your binary file manually, access artifacts and examine build logs. diff --git a/docs/enterprise-app-store/enterprise-app-store-profile.md b/docs/enterprise-app-store/enterprise-app-store-profile.md index 05e4b772b..5ded12801 100644 --- a/docs/enterprise-app-store/enterprise-app-store-profile.md +++ b/docs/enterprise-app-store/enterprise-app-store-profile.md @@ -40,7 +40,7 @@ Ensure that the bundle ID matches the current profile and that the version or bu ### Upload via Build Module -Binaries can also be uploaded via the Build module. For more information, please visit the [Build Configuration](/build/build-process-management/build-profile-configuration#distribution-configuration) and [Build Actions](/build/post-build-operations/after-a-build) documentations. +Binaries can also be uploaded via the Build module. For more information, please visit the [Build Configuration](/build/build-process-management/configurations#distribution-configuration) and [Build Actions](/build/build-process-management#binary-actions) documentations. ### Upload via Testing Distribution Module diff --git a/docs/publish-module/publish-walkthrough-for-app-store/index.md b/docs/publish-module/publish-walkthrough-for-app-store/index.md index fa3a7a43b..97fc5dc2d 100644 --- a/docs/publish-module/publish-walkthrough-for-app-store/index.md +++ b/docs/publish-module/publish-walkthrough-for-app-store/index.md @@ -206,7 +206,7 @@ You can deploy your binary file to the Publish module from the Build module auto :::info Upload via Build Module -To upload a binary from the Build module, please refer to the [**Distribution Configuration**](/build/build-process-management/build-profile-configuration#distribution-configuration) and [**Post-Build Operations**](/build/post-build-operations/after-a-build) documents for step-by-step instructions. +To upload a binary from the Build module, please refer to the [**Distribution Configuration**](/build/build-process-management/configurations#distribution-configuration) and [**Post-Build Operations**](/build/build-process-management#binary-actions) documents for step-by-step instructions. ::: diff --git a/docs/release-notes.md b/docs/release-notes.md index 4ff311572..3845a77e3 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -185,7 +185,7 @@ import RedisDomainCaution from '@site/docs/self-hosted-appcircle/install-server/ ### 🆕 New Features - Existing SSO & LDAP settings can now be duplicated when creating a new SSO or LDAP configuration. -- [Build priorities](build/build-process-management/build-profile-configuration#project-details-configuration) can now be configured as **High**, **Medium**, or **Low** to manage the start order of queued builds accordingly. Available for organizations with Enterprise License. +- [Build priorities](/build/build-process-management/configurations#build-priority) can now be configured as **High**, **Medium**, or **Low** to manage the start order of queued builds accordingly. Available for organizations with Enterprise License. ### :muscle: Improvements @@ -711,7 +711,7 @@ To ensure the App Store status remains current, the following conditions must be - You can now update the default release note of the app version provided by the Build Module. This will be sent as the "What to Test" area in [TestFlight](https://docs.appcircle.io/publish-integrations/ios-publish-integrations/sent-to-testflight). - Submit Store redirects have been eliminated from the site. - Incorporated a "Type" field into the data table within the [Environment Variable](https://docs.appcircle.io/environment-variables) sections, offering additional context regarding the type of each variable. -- [PAT (Personal Access Token) connections](https://docs.appcircle.io/build/manage-the-connections/#managing-pat-connections) listed on the build connection page are now deletable, providing users with the flexibility to manage their connections more efficiently. +- [PAT (Personal Access Token) connections](/build/manage-the-connections/reconnect-change-provider#managing-pat-connections) listed on the build connection page are now deletable, providing users with the flexibility to manage their connections more efficiently. - Branches are now filtered based on their status, enabling users to easily identify and navigate through branches based on their current state. - Users now have the capability to be redirected to their desired locations upon clicking on [Okta applications](/account/my-organization/security/authentications), enhancing navigation efficiency and user experience within the system. - When a build is [manually initiated](https://docs.appcircle.io/build/build-process-management/build-manually-or-with-triggers#manual-build), the system retrieves information about the user from the initiating organization. Conversely, if the build is [not initiated manually](https://docs.appcircle.io/build/build-process-management/build-manually-or-with-triggers#automatic-build), it displays the details of the user who made the commit, ensuring accurate attribution of actions within the system. @@ -863,7 +863,7 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal - A new module called [Publish](/publish-module) is introduced in beta, which helps manage App Store, Google Play, and Huawei AppGallery deployments with more efficiency. You can now modify publishing flows, add custom scripts, and control flow logic. - Members in the same [organization](/account/my-organization) can take ownership of previously added build profiles. -- The user can now add a new PAT (Personal Access Token) via the [Connections](/build/manage-the-connections#managing-pat-connections) page without creating a new build profile. +- The user can now add a new PAT (Personal Access Token) via the [Connections](/build/manage-the-connections/reconnect-change-provider#managing-pat-connections) page without creating a new build profile. - Enterprise customers can integrate their own authentication and OTP services and use them in conjunction with LDAP configuration on self-hosted installations. - The configuration file [global.yaml](../self-hosted-appcircle/install-server/linux-package/installation/docker#3-configure) now has a validator that helps users configure the settings correctly on export and prevents them from starting the server with broken settings. - The [certificate installer](../self-hosted-appcircle/install-server/linux-package/installation/docker#3-configure) tool now supports extracting proxy server certificates, which enable the runner to connect through a proxy without any SSL certificate error. @@ -885,11 +885,11 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal - Fixed an issue that caused the user to completely restrict their own [privileges](/account/my-organization/profile-and-team/team-management) when alone in an organization. - Fixed the case where the build pipeline was executed on a non-selected wrong pool, which was affecting the Appcircle Linux Pool (x86_64) and the Appcircle Standard macOS Pool (arm64). - Fixed an issue that was affecting the first-time [connections to the GitLab](/build/manage-the-connections/adding-a-build-profile/connecting-to-gitlab) provider. -- The bug was fixed in the re-creation of a connection that had been disconnected and had its [token revoked](/build/manage-the-connections#revoke-oauth-connections). +- The bug was fixed in the re-creation of a connection that had been disconnected and had its [token revoked](/build/manage-the-connections/reconnect-change-provider#revoke-oauth-connections). - Fixed a redirect issue when the user tried to connect to any Git provider without an active connection. - Fixed an issue with the [Unit and UI test](/continuous-testing/ios-testing/running-ios-unit-and-ui-tests) screenshots in the test reports. - Fixed an issue that occurred in the branch list and commits after [changing the git provider](/build/manage-the-connections/reconnect-change-provider#change-git-provider-and-reconnect) connection at the build profile. -- Fixed an issue that caused environment variables to be created with the same name in the same [environment variable](/environment-variables/managing-variables) group on the API. +- Fixed an issue that caused environment variables to be created with the same name in the same [environment variable](/build/build-environment-variables) group on the API. - An error that occurred after closing the repository list while trying to change the Git provider of a build profile connected to a repository has been fixed. - Fixed an issue that caused the [invited user](/account/my-organization/profile-and-team/team-management) not to be redirected to the sign up page if they were not registered. - Fixed an issue where the authentication logs section was not visible. @@ -917,7 +917,7 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal ### :muscle: Improvement -- Now builds that result in a [warning](/workflows/#build-warning-status) will also appear as a warning in the branch list. +- Now builds that result in a warning will also appear as a warning in the branch list. - Appcircle builds can now be displayed as “Appcircle/BuildProfileId” in pipelines on Git providers. - The URL format validation used when adding Git provider [instances](/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance) has been removed for self-hosted environments. - The [Testinium](/workflows/common-workflow-steps/#testinium) workflow component parses result summary and outputs in seperate environment variables. @@ -932,14 +932,14 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal - The loader did not appear when loading the [Enterprise App Store](/enterprise-app-store/enterprise-app-store-profile) page, the confusion caused by this has been fixed by adding the loader. - Fixed a bug when adding profiles using the [SSH connection](/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh) method. -- Fixed a bug during the [configuration cloning](/build/build-process-management/build-profile-configuration#clone-configuration) process. +- Fixed a bug during the configuration cloning process. - Page redirection issues were occurring on plan upgrade, this problem has been fixed. - Fixed an issue with the [Xcodebuild for Devices](../build/platform-build-guides/building-ios-applications) workflow step getting stuck in the build pipeline until timing out in some cases. - Fixed an issue that caused a build to be started in Appcircle when one of the _Approve_, _Approve with Recommendations_, _Wait for Author_, or _Reject_ activities was selected on pull requests when using the [Azure DevOps](/build/build-process-management/build-manually-or-with-triggers#managing-triggers-for-builds) Git provider. - Fixed a bug that prevented screenshots from being displayed as a result of the [Unit and UI Tests](/continuous-testing/ios-testing/running-ios-unit-and-ui-tests) in the test results section. - Fixed the issue that caused multiple builds to be launched when only one trigger was set on Appcircle and a trigger was triggered. - The incorrect "Configuration" information in the [e-mail notification](/account/my-organization/notifications/email-connection) sent as a result of the build in simultaneous build triggers has been corrected. -- When the [Environment Variables](/environment-variables/managing-variables) file was created from scratch and values were entered and downloaded, the downloaded file appeared empty. This error has been fixed. +- When the [Environment Variables](/build/build-environment-variables) file was created from scratch and values were entered and downloaded, the downloaded file appeared empty. This error has been fixed. ## 3.9.0 - 2023-11-01 - LDAP Support for User Authentication, Change the PAT by Build Profile, Download Environment Variables @@ -947,7 +947,7 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal - "Self-hosted Settings" has been introduced on the admin page for self-hosted Appcircle server. It includes [LDAP Login](/self-hosted-appcircle/install-server/linux-package/configure-server/integrations-and-access/ldap-settings#appcircle-login-with-ldap) for configuring LDAP user authentication and [Login Settings](/self-hosted-appcircle/install-server/linux-package/configure-server/integrations-and-access/login-configuration#login-settings) for other login configuration options. - Users are now allowed to manage their connections to private repositories after connecting their profiles. -- Now users are able to download the [environment variables](/environment-variables/managing-variables#download-environment-variables) in JSON format. +- Now users are able to download the [environment variables](/build/build-environment-variables) in JSON format. - Added a new environment variable called [AC_TRIGGER_REASON](/environment-variables/appcircle-specific-environment-variables#ios--android-common-environment-variables) that specifies the trigger that causes the build to start. - The "Appcircle Standard macOS Pool (arm64)" runners have [Xcode 15.1 beta-1](../build/platform-build-guides/building-ios-applications) installed. As this is a beta release, please test your workflows thoroughly. - A new filter has been added for filtering reports. Users will now be able to filter by organization and sub organization. @@ -962,7 +962,7 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal - We now support Azure DevOps Server 2020 connection while adding a [build profile](/build/manage-the-connections/adding-a-build-profile/connecting-to-azure). - The [public link](/testing-distribution/create-or-select-a-distribution-profile#public-link) in the test deployment area will now be available regardless of authentication type. - A bug that prevented failed builds from sending notifications to the MS Teams application has been fixed. -- Previously, you could only select one profile for test deployment. Now you can select [multiple profiles in the distribution](/build/build-process-management/build-profile-configuration#distribution-configuration) profile settings. +- Previously, you could only select one profile for test deployment. Now you can select [multiple profiles in the distribution](/build/build-process-management/configurations#distribution-configuration) profile settings. - Removed the obsolete icon from the Commit ID redirect link in the build profile details. - The cache size was bumped to 4 GB while using the [cache push](/workflows/common-workflow-steps/#cache-push) in the build pipeline. - We made improvements to the self-hosted server [SSL configuration](/self-hosted-appcircle/install-server/linux-package/configure-server/integrations-and-access/ssl-configuration) for enhanced security. @@ -989,12 +989,12 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal - The user can add [multiple instances](/build/manage-the-connections/adding-a-build-profile/connecting-multiple-instance) of the Git providers and select any of them to connect to. So the user can bind and build the repositories. - The [Xcode version](/self-hosted-appcircle/self-hosted-runner/configure-runner/manage-pools/#pool-based-xcode-version-selection) list of runners is integrated into the custom pool selection. It can be displayed dynamically in the build configuration, and the user can choose which Xcode version to build with. -- You can now quickly [copy a configuration](/build/build-process-management/build-profile-configuration#clone-configuration) and create a new one from that configuration. +- You can now quickly copy a configuration and create a new one from that configuration. ### :muscle: Improvement - Waiting times in Queue Waiting Reports are now shown in minutes instead of seconds. -- If the user selects any step that has the "Continue with the next step even if this step fails" option and gets a failure during the build on that step, this build's status is displayed as [Warning](/workflows/#build-warning-status). +- If the user selects any step that has the "Continue with the next step even if this step fails" option and gets a failure during the build on that step, this build's status is displayed as Warning. - Fixed the case that users belonging to more than one organization on [Azure DevOps](/build/manage-the-connections/adding-a-build-profile/connecting-to-azure) could not bind repository. - Improved suborganization experience in the Enterprise App Store by hiding the "Customize" and "Settings" sections, providing a more focused interface for suborganization administrators. - The latest stable version of [Xcode 15.0](../build/platform-build-guides/building-ios-applications) is available on both cloud and self-hosted runners. @@ -1035,14 +1035,14 @@ The single-node single drive [MinIO configuration](/self-hosted-appcircle/instal - Removed profile names will now appear as "Deleted" in corporate store reports. - The active build section now shows the email address that started the build, not the email address of the user who created the profile. -- If there is a space character in the [variable group](/environment-variables/managing-variables#using-environment-variables-for-ssh-and-pat-personal-access-token-connections-of-the-git-provider) name, it can be used within double quotes while connecting the repository. +- If there is a space character in the [variable group](/build/build-environment-variables) name, it can be used within double quotes while connecting the repository. - `$"Variable Group:Key"` -- Self-hosted enterprise customers can download the [configurations](/build/build-process-management/build-profile-configuration) of previous builds with the `.yaml` extension in "Build Details" section of the admin panel. +- Self-hosted enterprise customers can download the [configurations](/build/build-process-management/configurations) of previous builds with the `.yaml` extension in "Build Details" section of the admin panel. - Unsubscribe and resubscribe features are enabled for email notifications, distribution, and the enterprise app store. ### 🐞 Fixed -- The confusion regarding the use of Turkish characters when creating [workflows](/workflows) and [configurations](/build/build-process-management/build-profile-configuration) has been resolved. Turkish characters and some special characters can no longer be used in this section. +- The confusion regarding the use of Turkish characters when creating [workflows](/workflows) and [configurations](/build/build-process-management/configurations) has been resolved. Turkish characters and some special characters can no longer be used in this section. - The error in [permission management](/account/my-organization) in the environment variables section has been fixed. - The problem with the build transaction texts above the branch name in the "Branch" section being mixed up has been fixed. - The error in permission management in the [Enterprise App Store](/enterprise-app-store/enterprise-app-store-profile) section has been fixed. @@ -1741,7 +1741,7 @@ Within this release as prior to the previous release, Appcircle also supports [X ### ; 📑 Documentation -- Added [FAQ section](/build/post-build-operations/after-a-build#artifact-storage-is-full) of how to delete old artifacts. +- Added [FAQ section](/build/build-process-management/binary-actions#artifact-storage-is-full) of how to delete old artifacts. - Improved [Sending the build status to repository providers](https://docs.appcircle.io/build/building-ios-applications#sending-the-build-status-to-the-repository-providers) section for better CI/CD pipeline tracking. ## 2.3.0 - 2021-06-28 - Xcode Version Updates diff --git a/docs/self-hosted-appcircle/install-server/linux-package/installation/pre-installation-checklist.md b/docs/self-hosted-appcircle/install-server/linux-package/installation/pre-installation-checklist.md index 5c76bf832..8153f4be0 100644 --- a/docs/self-hosted-appcircle/install-server/linux-package/installation/pre-installation-checklist.md +++ b/docs/self-hosted-appcircle/install-server/linux-package/installation/pre-installation-checklist.md @@ -164,7 +164,7 @@ You can see details in the [DNS Settings](/self-hosted-appcircle/install-server/ - If you are using GitLab, Azure DevOps, Bitbucket: - [ ] Create an Appcircle user. Give it permissions for the repositories. - [ ] Create a personal access token that has sufficient permissions. - - For details like token permissions, check the [connect your repository](/build/manage-the-connections/adding-a-build-profile#connect-your-repository) section. + - For details like token permissions, check the [connect your repository](/build/manage-the-connections/adding-a-build-profile) section. - If you are using any other git server: - [ ] Create a public-private SSH key pair. - [ ] Configure your Appcircle git user's public SSH keys and upload the public SSH key you created. diff --git a/docs/tags.yml b/docs/tags.yml index f04a6f6d7..117f372ae 100644 --- a/docs/tags.yml +++ b/docs/tags.yml @@ -493,6 +493,11 @@ binaries: description: "Description for binaries" permalink: /binaries +"binary actions": + label: "binary actions" + description: "Description for binary actions" + permalink: /binary-actions + "binary distribution": label: "binary distribution" description: "Description for binary distribution" @@ -603,6 +608,11 @@ build: description: "Description for build profile configuration" permalink: /build-profile-configuration +"build profile management": + label: "build profile management" + description: "Description for build profile management" + permalink: /build-profile-management + "build sessions": label: "build sessions" description: "Description for build sessions" @@ -2783,11 +2793,16 @@ webhook: description: "Description for webhook secret" permalink: /webhook-secret -workflow: +"workflow": label: "workflow" description: "Description for workflow" permalink: /workflow +"workflows": + label: "workflows" + description: "Description for workflows" + permalink: /workflows + "xamarin": label: "xamarin" description: "Description for xamarin" diff --git a/docs/testing-distribution/index.md b/docs/testing-distribution/index.md index 4ec9785cb..8b9c20704 100644 --- a/docs/testing-distribution/index.md +++ b/docs/testing-distribution/index.md @@ -45,9 +45,9 @@ Optimize your application management with detailed reports. Utilize the App Shar ### No files or multiple files were received from autodistribute; -A successful distribution depends on a correctly signed binary. Please check if the [signing configuration](/build/build-process-management/build-profile-configuration#signing-configuration) is correct. +A successful distribution depends on a correctly signed binary. Please check if the [signing configuration](/build/build-process-management/configurations#signing-configuration) is correct. -You can also check the list of the [generated build artifacts](/build/post-build-operations/after-a-build) to confirm the output. In Android, you can also check the `ac_post_process_output.json` file in the build artifacts to see if the APKs are signed or not. +You can also check the list of the [generated build artifacts](/build/build-process-management#binary-actions) to confirm the output. In Android, you can also check the `ac_post_process_output.json` file in the build artifacts to see if the APKs are signed or not. In Android, please also check if gradle sign is being used for the selected build variant. If gradle sign works alongside with Appcircle signing, you will receive multiple APKs. diff --git a/docs/versioning/android-version.md b/docs/versioning/android-version.md index 87d466bd3..5f2324644 100644 --- a/docs/versioning/android-version.md +++ b/docs/versioning/android-version.md @@ -1,8 +1,8 @@ --- -title: Understanding Android Versioning +title: Android Versioning description: Learn how to manage version code and version name in Android projects with Appcircle tags: [android, versioning, version code, version name] -sidebar_position: 1 +sidebar_position: 2 --- import ContentRef from '@site/src/components/ContentRef'; diff --git a/docs/versioning/index.md b/docs/versioning/index.md index 9d03c780f..35800d0ee 100644 --- a/docs/versioning/index.md +++ b/docs/versioning/index.md @@ -10,18 +10,18 @@ import ContentRef from '@site/src/components/ContentRef'; Proper versioning is crucial for maintaining and updating mobile applications effectively. It helps in tracking different versions of your app, managing updates, and ensuring compatibility. -## [Understanding Android Versioning](/versioning/android-version) - -Android apps use a combination of `versionCode` and `versionName` in their build configurations: - -- `versionCode`: An integer value that represents the version of the application code, which is incremented with every release. -- `versionName`: A string value that represents the release version to the user. - -## [Understanding iOS Versioning](/versioning/ios-version) +## [iOS Versioning](/versioning/ios-version) iOS apps use `CFBundleShortVersionString` and `CFBundleVersion`: - `CFBundleShortVersionString`: The release version number displayed to users. - `CFBundleVersion`: The build number, which identifies an iteration of the app. -This section provides resources and guidelines to understand and manage the versioning system for both Android and iOS platforms. \ No newline at end of file +## [Android Versioning](/versioning/android-version) + +Android apps use a combination of `versionCode` and `versionName` in their build configurations: + +- `versionCode`: An integer value that represents the version of the application code, which is incremented with every release. +- `versionName`: A string value that represents the release version to the user. + +This section provides resources and guidelines to understand and manage the versioning system for both iOS and Android platforms. \ No newline at end of file diff --git a/docs/versioning/ios-version.md b/docs/versioning/ios-version.md index eaa564238..c5e5a8e16 100644 --- a/docs/versioning/ios-version.md +++ b/docs/versioning/ios-version.md @@ -1,8 +1,8 @@ --- -title: Understanding iOS Versioning +title: iOS Versioning description: Learn how to manage versioning for iOS applications in Appcircle tags: [versioning, ios] -sidebar_position: 2 +sidebar_position: 1 --- import ContentRef from '@site/src/components/ContentRef'; 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 eb5f7f692..5b0ea004a 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 @@ -49,11 +49,11 @@ This step contains some input variable(s). It needs these variable(s) to work. T -| 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 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 | +| 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 built. This variable can also be set via the build [Configuration](/build/build-process-management/configurations). 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 diff --git a/docs/workflows/android-specific-workflow-steps/android-build.md b/docs/workflows/android-specific-workflow-steps/android-build.md index ebb01a533..888dd360b 100644 --- a/docs/workflows/android-specific-workflow-steps/android-build.md +++ b/docs/workflows/android-specific-workflow-steps/android-build.md @@ -26,18 +26,18 @@ This step contains some input variable(s). It needs these variable(s) to work. T -| 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_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 | +| 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/configurations). 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/configurations). 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/configurations). | 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: +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/configurations) 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: @@ -62,7 +62,7 @@ The output(s) resulting from the operation of this component are as follows: | `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). +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/configurations). 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. @@ -137,7 +137,7 @@ Also, if you want to solve this issue via Android Studio you can follow this doc To generate an APK alongside an AAB, you can use one of these two methods: 1. **Adding Another Android Build Step:** - 1. **Configure for AAB:** Set up the build [configuration](/build/build-process-management/build-profile-configuration/) to generate an AAB. + 1. **Configure for AAB:** Set up the build [configuration](/build/build-process-management/configurations) to generate an AAB. 2. **Add another Android Build Step:** Add an additional **Android Build** step, after the first **Android Build** step. To avoid confusion, you can add the generates file type to the step name. 3. **Modify Output Type:** Change the `$AC_OUTPUT_TYPE` [input variables](#input-variables) of the second **Android Build** step to APK. Now your build will generate an AAB and APK file. @@ -146,7 +146,7 @@ To generate an APK alongside an AAB, you can use one of these two methods: If adding two **Android Build** steps makes the build process too lengthy, you can use the following alternative method: 2. **Generating APK from AAB file:** - 1. **Configure for AAB:** Set up the build [configuration](/build/build-process-management/build-profile-configuration/) to generate an AAB. + 1. **Configure for AAB:** Set up the build [configuration](/build/build-process-management/configurations) to generate an AAB. 2. **Add a Bundle Universal Apk Step:** Insert the [`Bundle Universal Apk`](/workflows/android-specific-workflow-steps/bundle-universal-apk) step in your workflow after the **Android Build** step. 3. **Configure the Bundle Universal Apk Step:** Complete the inputs for the **Bundle Universal Apk** step. To sign the APK via this step, you might need to upload your keystore file to the system if there is no uploaded. 4. **Convert AAB to APK:** This step will convert the generated AAB into an APK. 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 ad5698fd1..b35a04110 100644 --- a/docs/workflows/android-specific-workflow-steps/android-dependency-report.md +++ b/docs/workflows/android-specific-workflow-steps/android-dependency-report.md @@ -16,9 +16,9 @@ Rendering the dependency tree is particularly useful if you’d like to identify Before running the **Android Dependency Report** step, you must complete certain prerequisites, as detailed in the table below: -| Prerequisite Workflow Step | Description | -| ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| [**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. | +| Prerequisite Workflow Step | Description | +|------------------------------------------------------------------------------------| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| [**Git Clone**](/build/build-process-management/configurations) | 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. | @@ -28,12 +28,12 @@ This step contains some input variable(s). It needs these variable(s) to work. T -| 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](/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 | +| 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](/build/build-process-management/configurations) 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/configurations). 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 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 414ea84ec..62ac7d80e 100644 --- a/docs/workflows/android-specific-workflow-steps/android-unit-tests.md +++ b/docs/workflows/android-specific-workflow-steps/android-unit-tests.md @@ -36,12 +36,12 @@ This step contains some input variable(s). It needs these variable(s) to work. T -| 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 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 | +| 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 built. This variable can also be set via the build [Configuration](/build/build-process-management/configurations). 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/configurations). 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 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 7b2396e05..ca57dc1e4 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 @@ -51,7 +51,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 821262858..9140b5a6f 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 @@ -41,7 +41,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 42448e363..5e598afa2 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 @@ -32,15 +32,15 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-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](/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 | +| 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](/build/build-process-management/configurations). 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 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 48a36ebe3..7c5547f07 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 @@ -39,7 +39,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-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 890cd2b59..21b84c087 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 @@ -32,7 +32,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 a4ebd0ed4..707324b7f 100644 --- a/docs/workflows/android-specific-workflow-steps/bundle-universal-apk.md +++ b/docs/workflows/android-specific-workflow-steps/bundle-universal-apk.md @@ -36,13 +36,13 @@ This step contains some input variable(s). It needs these variable(s) to work. T | Variable Name | Description | Status | -| ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| ------------------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -------- | | `$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](/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 | +| `$AC_ANDROID_KEYSTORE_PATH` | (Autogenerated) The path to the keystore file selected via the build [Configuration](/build/build-process-management/configurations). 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/configurations). 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/configurations). 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/configurations). For more details, please refer to the [Android Keystores](/signing-identities/android-keystores) documentation. | Required | ### Output Variables 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 c621c98e2..d8720d324 100644 --- a/docs/workflows/android-specific-workflow-steps/firebase-test-lab.md +++ b/docs/workflows/android-specific-workflow-steps/firebase-test-lab.md @@ -69,7 +69,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/android-specific-workflow-steps/gradle-runner.md b/docs/workflows/android-specific-workflow-steps/gradle-runner.md index 94729d229..c18459c6f 100644 --- a/docs/workflows/android-specific-workflow-steps/gradle-runner.md +++ b/docs/workflows/android-specific-workflow-steps/gradle-runner.md @@ -26,15 +26,15 @@ This step contains some input variable(s). It needs these variable(s) to work. T -| 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 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 | -| `$AC_GRADLE_TASK_EXTRA_PARAMETERS` | Extra arguments were passed to the Gradle task. For more information, please refer to [this Gradle document](https://docs.gradle.org/current/userguide/writing_build_scripts.html#sec:extra_properties). | Optional | +| 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 built. This variable can also be set via the build [Configuration](/build/build-process-management/configurations). 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/configurations). 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 | +| `$AC_GRADLE_TASK_EXTRA_PARAMETERS` | Extra arguments were passed to the Gradle task. For more information, please refer to [this Gradle document](https://docs.gradle.org/current/userguide/writing_build_scripts.html#sec:extra_properties). | Optional | ### Output Variables diff --git a/docs/workflows/android-specific-workflow-steps/lint.md b/docs/workflows/android-specific-workflow-steps/lint.md index 8d36cb01d..87213ff17 100644 --- a/docs/workflows/android-specific-workflow-steps/lint.md +++ b/docs/workflows/android-specific-workflow-steps/lint.md @@ -34,16 +34,16 @@ This step contains some input variable(s). It needs these variable(s) to work. T -| 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 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. | Optional | +| 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 built. This variable can also be set via the build [Configuration](/build/build-process-management/configurations). 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/configurations). 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 | :::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. +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/configurations) document. 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 5cdc5ec4a..c929515cd 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 @@ -14,7 +14,7 @@ For additional details, please refer to the [**Emulator**](/infrastructure/andro :::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](/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/configurations#config-details) for selecting a pool in Configuration. ::: 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 a5a426f02..012675739 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 @@ -49,7 +49,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/azure-board.md b/docs/workflows/common-workflow-steps/azure-board.md index 9751fcb44..a00502ddd 100644 --- a/docs/workflows/common-workflow-steps/azure-board.md +++ b/docs/workflows/common-workflow-steps/azure-board.md @@ -51,7 +51,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/custom-script.md b/docs/workflows/common-workflow-steps/custom-script.md index dd0d21a40..5d4924705 100644 --- a/docs/workflows/common-workflow-steps/custom-script.md +++ b/docs/workflows/common-workflow-steps/custom-script.md @@ -34,7 +34,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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. +We recommend using [**Environment Variables**](/build/build-environment-variables) groups for such sensitive variables. ::: @@ -184,7 +184,7 @@ Please feel free to edit the following variables according to your own requireme ### 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. +Both user-created and Appcircle-reserved [environment variables](/build/build-environment-variables#adding-key-and-text-based-value-pairs) 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. In order to use all user environment variables with `sudo`, you should add the `-E` argument to the `sudo` command. The `-E` (preserve environment) option indicates to the security policy that the user wishes to preserve their existing environment variables. @@ -297,7 +297,7 @@ This script is written in `Bash`. When running with **Custom Script**, you need :::note Input Variables When using your own SMTP server credentials for the three variables below, using **Environment Variables** is strongly suggested since this prevents sensitive information, such as passwords, from being exposed to unauthorized individuals. -For more detailed information, please refer to the [**Environment Variables**](/environment-variables/managing-variables) documentation. +For more detailed information, please refer to the [**Environment Variables**](/build/build-environment-variables) documentation. - **$CS_EMAIL**: SMTP Server email address. - **$CS_USERNAME**: Sender email address. @@ -320,7 +320,7 @@ If you want to send an email to multiple email addresses instead of a single ema :::danger Sensitive Informations -Since the variables mentioned above, which need to be provided by the user, contain **sensitive** information like **passwords**, please use [**Environment Variables**](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs) for these types of values. +Since the variables mentioned above, which need to be provided by the user, contain **sensitive** information like **passwords**, please use [**Environment Variables**](/build/build-environment-variables#adding-key-and-text-based-value-pairs) for these types of values. To do this, comment out or remove the sensitive variables such as `$CS_EMAIL`, `$CS_USERNAME`, and `$CS_PASSWORD` defined at the top of the script, and add them as environment variables instead. @@ -372,7 +372,7 @@ Here is an example using Dropbox's [file-upload](https://www.dropbox.com/develop :::danger Ensure sensitive data, like access tokens, are defined as private environment variables. Learn more: -- [Adding key and text-based value pairs](/environment-variables/managing-variables#adding-key-and-text-based-value-pairs) +- [Adding key and text-based value pairs](/build/build-environment-variables#adding-key-and-text-based-value-pairs) ::: diff --git a/docs/workflows/common-workflow-steps/danger.md b/docs/workflows/common-workflow-steps/danger.md index 7565ed32c..43ee87386 100644 --- a/docs/workflows/common-workflow-steps/danger.md +++ b/docs/workflows/common-workflow-steps/danger.md @@ -49,7 +49,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 1ffc879bc..8079c26f9 100644 --- a/docs/workflows/common-workflow-steps/data-theorem-mobile-secure.md +++ b/docs/workflows/common-workflow-steps/data-theorem-mobile-secure.md @@ -59,7 +59,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/firebase-app-distribution.md b/docs/workflows/common-workflow-steps/firebase-app-distribution.md index 5c5759989..6ab6775ca 100644 --- a/docs/workflows/common-workflow-steps/firebase-app-distribution.md +++ b/docs/workflows/common-workflow-steps/firebase-app-distribution.md @@ -72,7 +72,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/fod-mobile-assesment.md b/docs/workflows/common-workflow-steps/fod-mobile-assesment.md index 102c80709..57b309957 100644 --- a/docs/workflows/common-workflow-steps/fod-mobile-assesment.md +++ b/docs/workflows/common-workflow-steps/fod-mobile-assesment.md @@ -62,7 +62,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/ftp-upload.md b/docs/workflows/common-workflow-steps/ftp-upload.md index 3e29e6b5e..d0ebf2668 100644 --- a/docs/workflows/common-workflow-steps/ftp-upload.md +++ b/docs/workflows/common-workflow-steps/ftp-upload.md @@ -41,7 +41,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/jira-comment.md b/docs/workflows/common-workflow-steps/jira-comment.md index a7aef7660..047c0ff73 100644 --- a/docs/workflows/common-workflow-steps/jira-comment.md +++ b/docs/workflows/common-workflow-steps/jira-comment.md @@ -74,7 +74,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/maestro-cloud-upload.md b/docs/workflows/common-workflow-steps/maestro-cloud-upload.md index f4ace693c..d2f0b2fc7 100644 --- a/docs/workflows/common-workflow-steps/maestro-cloud-upload.md +++ b/docs/workflows/common-workflow-steps/maestro-cloud-upload.md @@ -67,7 +67,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/marathon-cloud.md b/docs/workflows/common-workflow-steps/marathon-cloud.md index 40b0c39bf..97eec1e1b 100644 --- a/docs/workflows/common-workflow-steps/marathon-cloud.md +++ b/docs/workflows/common-workflow-steps/marathon-cloud.md @@ -55,7 +55,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/repeato-test-runner.md b/docs/workflows/common-workflow-steps/repeato-test-runner.md index 1197aa1f5..3219c2603 100644 --- a/docs/workflows/common-workflow-steps/repeato-test-runner.md +++ b/docs/workflows/common-workflow-steps/repeato-test-runner.md @@ -44,7 +44,7 @@ Specific input variables are required for the **Repeato Test Runner** to functio 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/saucectl-run.md b/docs/workflows/common-workflow-steps/saucectl-run.md index c00d3cac5..7bbd3e0fa 100644 --- a/docs/workflows/common-workflow-steps/saucectl-run.md +++ b/docs/workflows/common-workflow-steps/saucectl-run.md @@ -146,4 +146,4 @@ For each component, specific input variables are required for its operation on y The artifacts generated from the **Saucectl Run** step are saved in the directory specified by **Sauce Labs Download Directory** (`AC_SL_DOWNLOAD_DIR`). You can control the format of these outputs using the **Sauce Labs Download Match** (`AC_SL_DOWNLOAD_MATCH`) parameter and determine when they are downloaded using the **Sauce Labs When to Download Artifacts** (`AC_SL_WHEN_ARTIFACT_DOWNLOAD`) parameter. -To access all saved artifacts, go to the [Download Artifacts](/build/post-build-operations/after-a-build#download-artifacts) section in Appcircle at the end of the build log. \ No newline at end of file +To access all saved artifacts, go to the [Download Artifacts](/build/build-process-management/binary-actions#download-artifacts) section in Appcircle at the end of the build log. \ No newline at end of file diff --git a/docs/workflows/common-workflow-steps/set-environment-variable.md b/docs/workflows/common-workflow-steps/set-environment-variable.md index f1200122f..d2f417a34 100644 --- a/docs/workflows/common-workflow-steps/set-environment-variable.md +++ b/docs/workflows/common-workflow-steps/set-environment-variable.md @@ -31,7 +31,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/snyk-scan-security.md b/docs/workflows/common-workflow-steps/snyk-scan-security.md index 009079ee6..76af688fd 100644 --- a/docs/workflows/common-workflow-steps/snyk-scan-security.md +++ b/docs/workflows/common-workflow-steps/snyk-scan-security.md @@ -32,7 +32,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/common-workflow-steps/testinium.md b/docs/workflows/common-workflow-steps/testinium.md index e86c90a13..1ac5ba2b0 100644 --- a/docs/workflows/common-workflow-steps/testinium.md +++ b/docs/workflows/common-workflow-steps/testinium.md @@ -59,7 +59,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 54aafe03a..e5a644335 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 @@ -18,7 +18,7 @@ There are no prerequisites required before using the **Upload Files to Amazon S3 :::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. +To begin, add the **Upload Files to Amazon S3** step to the workflow from the [workflow marketplace](/build/build-process-management/build-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. @@ -43,7 +43,7 @@ This step contains some input variable(s). It needs these variable(s) to work. 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](/build/build-environment-variables) instead of typing them here for security purposes. ::: diff --git a/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md b/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md index eb32dc22a..a3afe0549 100644 --- a/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md +++ b/docs/workflows/flutter-specific-workflow-steps/firebase-deployment.md @@ -33,7 +33,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 fb560d785..09734bdf7 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 @@ -35,7 +35,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T :::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/configurations). The details you provide in the configuration will serve as input for the **Android Build** step. Kindly substitute the example information with your details: @@ -52,7 +52,7 @@ The output(s) resulting from the operation of this component are as follows: :::info -The resulting files will be either APK or AAB, based on the `Output Type` selected in the project [Configuration](/build/build-process-management/build-profile-configuration). +The resulting files will be either APK or AAB, based on the `Output Type` selected in the project [Configuration](/build/build-process-management/configurations). ::: diff --git a/docs/workflows/index.md b/docs/workflows/index.md index 4ebe12d4d..627888d9c 100644 --- a/docs/workflows/index.md +++ b/docs/workflows/index.md @@ -78,88 +78,32 @@ Please note that modifying workflow steps may cause your builds to fail, so utmo ::: -### Setting Up Workflows +## [Common Workflow Steps](/workflows/common-workflow-steps) -To access the workflow editor for a build profile, click the Workflows button in the context menu of the build profile, accessible from the top of the profile details. +These steps are common across all build profiles regardless of the target OS and platform. - +You can find the full list of available workflow steps in our [workflow marketplace](https://github.com/appcircleio/appcircle-workflow-components) and under each workflow step in this document, you can find the related repository URL, which also includes the documentation for the related step. -The workflow list will be displayed. To view the [Workflow Steps](#workflow-steps) of a workflow, click on it from the workflow list. +## [iOS Integration](/workflows/ios-specific-workflow-steps) - +These steps are specific to the iOS build profiles. -To create a new workflow, press the "New" button at the top of the workflow list and select a template from the default workflows. Then edit the workflow name and press enter. You can also upload your workflow as a YAML file. +You can find the full list of available workflow steps in our [workflow marketplace](https://github.com/appcircleio/appcircle-workflow-components) and under each workflow step in this document, you can find the related repository URL, which also includes the documentation for the related step. - +## [Android Integration](/workflows/android-specific-workflow-steps) -To rename/delete a current workflow, press the "Edit" button at the top of the workflow list and then click on the context menu that appears next to the workflow items. +These steps are specific to the Android build profiles. - +You can find the full list of available workflow steps in our [workflow marketplace](https://github.com/appcircleio/appcircle-workflow-components) and under each workflow step in this document, you can find the related repository URL, which also includes the documentation for the related step. -You can use the "Clone" option to create a new workflow based on the currently available ones. You can [select different workflows for different build scenarios](/build/build-process-management/build-manually-or-with-triggers) (e.g. separate workflows for production and development). +## [React Native Integration](/workflows/react-native-specific-workflow-steps) - +These steps are specific to the React Native build profiles. -### Workflow Steps +You can find the full list of available workflow steps in our [workflow marketplace](https://github.com/appcircleio/appcircle-workflow-components) and under each workflow step in this document, you can find the related repository URL, which also includes the documentation for the related step. - +## [Flutter Integration](/workflows/flutter-specific-workflow-steps) -Appcircle will build your application with the steps defined in the workflow. Steps will be executed in order from the top to the bottom. +These steps are specific to the Flutter build profiles. -You can customize each step for specific configurations with your application structure. Step parameters can be modified, outputs of each step can be used in another step and step versions can be selected accordingly. - -### Workflow Marketplace - -Appcircle's powerful Workflow Editor has a built-in Workflow Marketplace that allows you to select and insert an unlimited amount of steps to your workflow. - -You can find the full list of available workflow steps in our workflow marketplace at:; - -[https://www.appcircle.io/integrations/](https://www.appcircle.io/integrations/) - -You can add platform-specific workflow steps, custom scripts, and other steps into your workflow and re-order them as you like. You can also remove the steps you don't need. You can backup your current workflow by clicking the **Download YAML** button at the bottom. - - - -To access the Workflow Marketplace, click on the **Manage Workflow** button. You will see the Workflow Marketplace on the right and your Workflow steps on the left. - -You can now drag and drop steps into your workflow. Any unwanted workflow steps can be removed by clicking on the delete button on the right side of each step. - -You can also reorder steps so that they will be executed in the order you specify. - - - -### Editing Workflow Settings - -Each workflow step has its own set of configuration options, which can be set by clicking on the step in the workflow screen. - -The first three items are common for all steps and they are set individually for each step: - -- **Step Execution Active:** To enable/disable the step execution without removing it from the workflow - -- **Continue with the next step even if this step fails:** If a step is optional or its result should not cause a build error, you can select this option to continue the workflow if this particular step fails. In default workflows, this option is `on` for specific steps. And since this step is active, the build status will appear as "Warning" when other steps in the build are successful. Detailed explanation about this state is given in the [Build Warning Status](#build-warning-status) section. - -- **Workflow Step Version:** You can select a specific version of a step with which to execute your build. If you select a version with an asterisk (\*), you will receive the minor updates to the workflow step automatically. The major versions may include added or removed input fields and manual version selection is required for major version updates.; - -The items in the "Inputs" section are specific to that step. The reserved environment variables are assigned to these fields by default and the values of these variables are set in the build configuration. - - - -#### Build Warning Status - -When we start a build, if we have activated the "Continue with the next step even if this step fails" setting for a component we use in the workflow and this step fails during the build, Appcircle will show the build status as "Warning" if the build is completed successfully for other steps. - -In order to simulate the warning state and see its results on the pipeline, we can basically write a script that will fail in Custom Script. - - - -"Continue with the next step even if this step fails" must be `on` in this case. - - - -We are starting a build, and we see that it fails in the pipeline. - - - -And the build status will now appear as "Warning". - - +You can find the full list of available workflow steps in our [workflow marketplace](https://github.com/appcircleio/appcircle-workflow-components) and under each workflow step in this document, you can find the related repository URL, which also includes the documentation for the related step. \ No newline at end of file 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 b453fb5e1..83e6b965e 100644 --- a/docs/workflows/ios-specific-workflow-steps/appcenter-ios-distribution.md +++ b/docs/workflows/ios-specific-workflow-steps/appcenter-ios-distribution.md @@ -36,7 +36,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 78aaf167d..a94f922f2 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 @@ -40,7 +40,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 584aae256..96a023975 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 @@ -48,7 +48,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 a11a3c814..804818261 100644 --- a/docs/workflows/ios-specific-workflow-steps/browserstack-app-automation.md +++ b/docs/workflows/ios-specific-workflow-steps/browserstack-app-automation.md @@ -37,7 +37,7 @@ The output(s) resulting from the operation of this component are as follows: 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**](/build/build-environment-variables) groups for such sensitive variables. ::: diff --git a/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md b/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md index 5ec0e730a..a10f747e5 100644 --- a/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md +++ b/docs/workflows/ios-specific-workflow-steps/cocoapods-install.md @@ -26,11 +26,11 @@ This step contains some input variable(s). It needs these variable(s) to work. T -| 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](/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 | +| 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](/build/build-process-management/configurations). | 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 diff --git a/docs/workflows/ios-specific-workflow-steps/tuist-install.md b/docs/workflows/ios-specific-workflow-steps/tuist-install.md index 09caed376..57e84a6c7 100644 --- a/docs/workflows/ios-specific-workflow-steps/tuist-install.md +++ b/docs/workflows/ios-specific-workflow-steps/tuist-install.md @@ -42,7 +42,7 @@ For more iOS specific workflow steps, please visit the [**iOS Integration**](/wo :::danger -In Tuist integrated projects, there will be cases where `.xcworkspace` and `.xcodeproj` files will be created after the `tuist generate` command. For this reason, the **auto fill** feature in the **build configuration** may not work as expected. For more information about build configurations, please visit the [**Build Configurations**](/build/build-process-management/build-profile-configuration) documentation. +In Tuist integrated projects, there will be cases where `.xcworkspace` and `.xcodeproj` files will be created after the `tuist generate` command. For this reason, the **auto fill** feature in the **build configuration** may not work as expected. For more information about build configurations, please visit the [**Build Configurations**](/build/build-process-management/configurations) documentation. ::: diff --git a/docs/workflows/ios-specific-workflow-steps/xcode-select.md b/docs/workflows/ios-specific-workflow-steps/xcode-select.md index bae91e04f..b95d68d41 100644 --- a/docs/workflows/ios-specific-workflow-steps/xcode-select.md +++ b/docs/workflows/ios-specific-workflow-steps/xcode-select.md @@ -8,7 +8,7 @@ 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](/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/configurations) tab. ### Prerequisites @@ -22,7 +22,7 @@ Always use this step **before** [**CocoaPods Install**](/workflows/ios-specific- :::caution -Please **don't forget** to select the **Xcode version** from [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration) first. +Please **don't forget** to select the **Xcode version** from [Configuration](/build/build-process-management/configurations) first. ::: @@ -30,7 +30,7 @@ Please **don't forget** to select the **Xcode version** from [Configuration](/bu ### Version Change -- To select an Xcode version, open [Configuration](/build/platform-build-guides/building-ios-applications#build-configuration) in the build profile. +- To select an Xcode version, open [Configuration](/build/build-process-management/configurations) in the build profile. 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 b7df053cb..3a6c3ae49 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 @@ -32,7 +32,7 @@ This step contains some input variable(s). It needs these variable(s) to work. T 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**](/build/build-environment-variables) groups for such sensitive variables. ::: 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 2b0207030..d917a1502 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 @@ -52,7 +52,7 @@ If your **CocoaPods** dependencies are **embedded** in the project, you do not n :::danger React Native UI Test for Android -For Appcircle **Cloud**, you need to use **Appcircle Linux Pool (x86_64)** to run your UI tests on the Android platform. Since **Appcircle Standard macOS Pool (arm64)** is based on **Apple Silicon's virtualization** technology, it does not support running Android emulators. If your organization has **self-hosted pools**, you can choose and use any pool that has bare-metal machines or VMs that support nested virtualization. For more information, please follow the [**Build Configuration**](/build/build-process-management/build-profile-configuration) and [**Android Build Infrastructure**](/infrastructure/android-build-infrastructure) documentations. +For Appcircle **Cloud**, you need to use **Appcircle Linux Pool (x86_64)** to run your UI tests on the Android platform. Since **Appcircle Standard macOS Pool (arm64)** is based on **Apple Silicon's virtualization** technology, it does not support running Android emulators. If your organization has **self-hosted pools**, you can choose and use any pool that has bare-metal machines or VMs that support nested virtualization. For more information, please follow the [**Build Configuration**](/build/build-process-management/configurations) and [**Android Build Infrastructure**](/infrastructure/android-build-infrastructure) documentations. ::: diff --git a/netlify.toml b/netlify.toml index 3bfe1d2a7..c84563783 100644 --- a/netlify.toml +++ b/netlify.toml @@ -514,6 +514,21 @@ from = "/infrastructure/accessing-repositories-in-internal-networks-firewalls" to = "/build/manage-the-connections/accessing-repositories-in-internal-networks-firewalls" status = 301 +[[redirects]] +from = "/build/build-process-management/build-profile-configuration" +to = "/build/build-process-management/configurations" +status = 301 + +[[redirects]] +from = "/build/post-build-operations" +to = "/build/build-process-management/binary-actions" +status = 301 + +[[redirects]] +from = "/build/post-build-operations/after-a-build" +to = "/build/build-process-management/binary-actions" +status = 301 + [[redirects]] from = "/tutorials/how-to-add-a-flutter-app" to = "/build/platform-build-guides/building-flutter-applications" @@ -805,7 +820,7 @@ status = 301 [[redirects]] from = "/integrations/workflow-marketplace" -to = "/workflows/#workflow-marketplace" +to = "/build/build-process-management/build-workflows" status = 301 [[redirects]]