Skip to content

Commit 4d87b42

Browse files
committed
Added Build Parameters Guide in App & App Group
1 parent 1bd4eed commit 4d87b42

File tree

2 files changed

+51
-7
lines changed

2 files changed

+51
-7
lines changed

docs/user-guide/application-groups.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,17 @@ The **Build & Deploy** tab of your application group enables you to trigger the
5353

5454
![Figure 5: Selecting Commit](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-commit-1.jpg)
5555

56-
Repeat the step for other applications, and then click **Start Build**.
56+
{% hint style="info" %}
57+
### Passing Build Parameters [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
58+
59+
Similar to application, you can also [pass build parameters](./deploying-application/triggering-ci.md#passing-build-parameters) in application groups before triggering the build.
60+
{% endhint %}
61+
62+
3. Repeat the step for other applications, and then click **Start Build**.
5763

5864
![Figure 6: Building Images](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/select-commit-2.jpg)
5965

60-
3. The builds will be initiated, following which, you can close the `Build image` screen.
66+
4. The builds will be initiated, following which, you can close the `Build image` screen.
6167

6268
![Figure 7: Triggered Deployment](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/application-groups/build-image.jpg)
6369

docs/user-guide/deploying-application/triggering-ci.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Triggering CI Pipelines
22

3-
To trigger the CI pipeline, first you need to select a Git commit. To select a Git commit, clic the **Select Material** button present on the CI pipeline.
3+
To trigger the CI pipeline, first you need to select a Git commit. To select a Git commit, click the **Select Material** button present on the CI pipeline.
44

55
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/select-material-new.jpg)
66

@@ -10,9 +10,9 @@ Once clicked, a list will appear showing various commits made in the repository,
1010

1111
CI Pipelines with automatic trigger enabled are triggered immediately when a new commit is made to the git branch. If the trigger for a build pipeline is set to manual, it will not be automatically triggered and requires a manual trigger.
1212

13-
{% hint style="info" %}
13+
---
1414

15-
### Partal Cloning Feature [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
15+
## Partal Cloning Feature [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
1616

1717
CI builds can be time-consuming for large repositories, especially for enterprises. However, Devtron's partial cloning feature significantly increases cloning speed, reducing the time it takes to clone your source code and leading to faster build times.
1818

@@ -22,13 +22,51 @@ CI builds can be time-consuming for large repositories, especially for enterpris
2222
* Faster software releases
2323
* Improved productivity
2424

25-
Get in touch with us if you are looking for a way to improve the efficiency of your software development process
26-
{% endhint %}
25+
Get in touch with us if you are looking for a way to improve the efficiency of your software development process.
2726

2827
The **Refresh** icon updates the Git Commits section in the CI Pipeline by fetching the latest commits from the repository. Clicking on the refresh icon ensures that you have the most recent commit available.
2928

3029
The **Ignore Cache** option ignores the previous build cache and creates a fresh build. If selected, will take a longer build time than usual.
3130

31+
---
32+
33+
## Passing Build Parameters [![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/elements/EnterpriseTag.svg)](https://devtron.ai/pricing)
34+
35+
{% hint style="warning" %}
36+
### Who Can Perform This Action?
37+
Users need to have [Build & deploy permission](../global-configurations/authorization/user-access.md#role-based-access-levels) or above (along with access to the environment and application) to pass build parameters.
38+
{% endhint %}
39+
40+
If you wish to pass runtime parameters for build job, you can provide key-value pairs before triggering the build. This will inject those key-value pairs as environment variables in CI runner pods and all its containers.
41+
42+
**Steps**
43+
44+
1. Go to the **Parameters** tab available on the screen where you select the commit.
45+
46+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/build-parameter-tab.jpg)
47+
48+
2. Click **+ Add parameter**.
49+
50+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/add-parameter.jpg)
51+
52+
3. Enter your key-value pair as shown below.
53+
54+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploying-application/triggering-ci/key-value.jpg)
55+
56+
<br /> Similarly, you may add more than one key-value pair by using the **+ Add Parameter** button.
57+
58+
4. Click **Start Build**.
59+
60+
{% hint style="info" %}
61+
Passing build parameters is currently not supported for [Linked Build pipeline](../creating-application/workflow/ci-pipeline.md#2-linked-build-pipeline) and [External CI pipeline](../creating-application/workflow/ci-pipeline.md#3-deploy-image-from-external-service).
62+
63+
In case you trigger builds in bulk, you can consider passing build parameters in [Application Group](../application-groups.md).
64+
{% endhint %}
65+
66+
---
67+
68+
## Fetching Logs and Reports
69+
3270
Click the `CI Pipeline` or navigate to the `Build History` to get the CI pipeline details such as build logs, source code details, artifacts, and vulnerability scan reports.
3371

3472
To access the logs of the CI Pipeline, simply click `Logs`.

0 commit comments

Comments
 (0)