Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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).

:::

Expand Down Expand Up @@ -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).

:::

Expand Down
6 changes: 6 additions & 0 deletions docs/build/build-environment-variables/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"label": "Environment Variables",
"position": 2,
"collapsed": true,
"collapsible": true
}
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -115,7 +115,7 @@ Then in workflows, you can specify the environment variable for use.

<Screenshot url='https://cdn.appcircle.io/docs/assets/build-configuration-env-variables.png' />

### 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.

Expand All @@ -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.

Expand Down Expand Up @@ -169,3 +169,5 @@ If your SSH public key is not defined on the Git provider, Appcircle will not be
:::

<ContentRef url="/build/manage-the-connections/adding-a-build-profile/connecting-to-private-repository-via-ssh">Connecting to Repository via SSH</ContentRef>

For platform specific environment variables and more detailed information, please refer to the related [documentation](/environment-variables/platform-specific-usage).
6 changes: 3 additions & 3 deletions docs/build/build-history.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
:::

<Screenshot url='https://cdn.appcircle.io/docs/assets/build-history-new.png' />
<Screenshot url='https://cdn.appcircle.io/docs/assets/BE5278-history.png' />
4 changes: 2 additions & 2 deletions docs/build/build-process-management/_category_.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"label": "Build Profile Management",
"position": 2,
"label": "Build Profile",
"position": 1,
"collapsed": true,
"collapsible": true
}
Original file line number Diff line number Diff line change
@@ -1,60 +1,61 @@
---
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.
<Screenshot url='https://cdn.appcircle.io/docs/assets/BE5278-action.png' />

<Screenshot url='https://cdn.appcircle.io/docs/assets/build-ios-distribute-artifacts.png' />
## 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

Please note that AAB files will not be distributed automatically since they cannot be installed on mobile devices directly.

:::

### View Build Logs
<Screenshot url='https://cdn.appcircle.io/docs/assets/BE5278-dist.png' />

## 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
<Screenshot url='https://cdn.appcircle.io/docs/assets/BE5278-log.png' />

## 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

Expand All @@ -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.

<Screenshot url='https://cdn.appcircle.io/docs/assets/build-delete-specific.png' />
<Screenshot url='https://cdn.appcircle.io/docs/assets/BE5278-delete5.png' />

:::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.

:::

Expand All @@ -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

Expand All @@ -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';

<NeedHelp />
<NeedHelp />
Loading