You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-app-configuration/concept-github-action.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
-
title: Use GitHub Actions with Azure App Configuration Sync | Microsoft Docs
3
-
description: Use GitHub Actions to trigger an update to your App Configuration store when defined actions are performed on a GitHub repository
2
+
title: Use GitHub Actions with Azure App Configuration Sync
3
+
description: Use GitHub Actions to trigger an update to your App Configuration instance when defined actions are performed on a GitHub repository
4
4
author: jpconnock
5
5
6
6
ms.author: jeconnoc
@@ -9,16 +9,16 @@ ms.topic: conceptual
9
9
ms.service: azure-app-configuration
10
10
11
11
---
12
-
# Sync your App Configuration Store using GitHub Actions
13
-
Azure App Configuration uses GitHub Actions to update an App Configuration store when certain actions are performed on a GitHub repository. This allows you to leverage GitHub workflows to update app configuration rather than performing updates in the Azure portal, and enables you to integrate app configuration updates into the same workflow used to update app code.
12
+
# Sync your App Configuration Instance using GitHub Actions
13
+
Azure App Configuration uses GitHub Actions to update an App Configuration instance when triggered by an action performed on a GitHub repository. You can leverage GitHub workflows to update app configuration, enabling the integration of app configuration updates into the same workflow used to update app code.
14
14
15
15
A GitHub Actions [workflow](https://help.github.com/articles/about-github-actions#workflow) is an automated process defined in your GitHub repository. This process tells GitHub how to build and deploy your GitHub project. Azure App Configuration provides the *Azure App Configuration Sync* Action to enable updates to an App Configuration instance when changes are made to the source repository.
16
16
17
-
A workflow is defined by a YAML (.yml) file in the /.github/workflows/ path of your repository. This definition contains the various steps and parameters that make up the workflow.
17
+
A workflow is defined by a YAML (.yml) file found in the `/.github/workflows/` path of your repository. This definition contains the various steps and parameters that define the workflow.
18
18
19
-
GitHub events, such as a push to a repository, can trigger a GitHub Action workflow. *Azure App Configuration Sync*is a GitHub action provided by Azure to enable you to trigger an update of an App Configuration store when a specified GitHub action is triggered. This allows teams to leverage GitHub's core features when pushing, reviewing, or branching app configuration files just as they do with app code.
19
+
GitHub events, such as a push to a repository, can trigger a GitHub Action workflow. Azure provides the *Azure App Configuration Sync* action to enable you to trigger an update of an App Configuration instance when a specified GitHub action occurs. This allows teams to leverage GitHub's core features when pushing, reviewing, or branching app configuration files just as they do with app code.
20
20
21
-
The GitHub [documentation](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-a-workflow) provides in-depth view of GitHub workflows and actions.
21
+
The GitHub [documentation](https://help.github.com/actions/automating-your-workflow-with-github-actions/configuring-a-workflow) provides in-depth view of GitHub workflows and actions.
22
22
23
23
## Enable GitHub Actions in your repository
24
24
To start using this GitHub action, go to your repository and select the **Actions** tab. Find the GitHub action in the marketplace by searching for "Azure App Configuration Sync".
@@ -30,7 +30,7 @@ To start using this GitHub action, go to your repository and select the **Action
30
30
## Sync configuration files after a push
31
31
This action syncs Azure App Configuration files when a change is pushed to `appsettings.json`. When a developer makes and pushes a change to `appsettings.json`, the App Configuration Sync action updates the App Configuration instance with the new values.
32
32
33
-
The first section of this code specifies that the action triggers *on* a *push* containing `appsettings.json` to the *master* branch. The second section specifies the jobs run once the action is triggered. The action checks out the relevant files and updates the App Configuration store using the connection string stored as a secret in the repository.
33
+
The first section of this workflow specifies that the action triggers *on* a *push* containing `appsettings.json` to the *master* branch. The second section lists the jobs run once the action is triggered. The action checks out the relevant files and updates the App Configuration instance using the connection string stored as a secret in the repository. For more information about using secrets in Github, see [this article](https://help.github.com/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) about creating and using encrypted secrets.
34
34
35
35
```json
36
36
on:
@@ -57,9 +57,9 @@ jobs:
57
57
```
58
58
59
59
## Use a dynamic label on sync
60
-
The previous action simply updated the App Configuration store whenever `appsettings.json` is updated. This action inserts a dynamic label on each sync, ensuring that each sync can be uniquely identified. This allows code changes to quickly be mapped to config changes.
60
+
The previous action simply updated the App Configuration instance whenever `appsettings.json` is updated. This action inserts a dynamic label on each sync, ensuring that each sync can be uniquely identified. This allows code changes to quickly be mapped to config changes.
61
61
62
-
The first section of this code specifies that the action triggers *on* a *push* containing `appsettings.json` to the *master* branch. The second section runs a job which creates a unique label for the config update based on the commit hash. The job then updates the App Configuration store with the new values and the unique label for this update.
62
+
The first section of this code specifies that the action triggers *on* a *push* containing `appsettings.json` to the *master* branch. The second section runs a job which creates a unique label for the config update based on the commit hash. The job then updates the App Configuration instance with the new values and the unique label for this update.
63
63
64
64
```json
65
65
on:
@@ -138,7 +138,7 @@ The default behavior for nested JSON attributes is to flatten the entire object.
138
138
}
139
139
}
140
140
```
141
-
If the nested object is intended to be the value pushed to the Configuration Store, you can use the *depth* value to stop the flattening at the appropriate depth.
141
+
If the nested object is intended to be the value pushed to the Configuration instance, you can use the *depth* value to stop the flattening at the appropriate depth.
142
142
143
143
```json
144
144
on:
@@ -172,24 +172,24 @@ Given a depth of 2, the example above now returns the following key:value pair:
172
172
| Object:Inner| InnerKey:InnerValue|
173
173
174
174
## Understand Action Inputs
175
-
Input parameters allow you to specify data that the action expects to use during runtime. Below is a table containing the input parameters accepted by App Configuration Sync and the expected values for each. For more information about action inputs for GitHub Actions, refer to GitHub's [documentation](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputs)
175
+
Input parameters specify data used by the action during runtime. The following table contains input parameters accepted by App Configuration Sync and the expected values for each. For more information about action inputs for GitHub Actions, see GitHub's [documentation](https://help.github.com/actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputs).
176
176
177
-
> [!IMPORTANT]
178
-
> Input IDs with uppercase letters are converted to lowercase during runtime. We recommend using lowercase input IDs.
177
+
> [!Note]
178
+
> Input IDs with uppercase letters are converted to lowercase during runtime.
179
179
180
180
181
181
| Input Name | Required? | Value |
182
182
|----|----|----|
183
-
|configurationFile| Yes | Path to the configuration file in the repository, relative to the root of the repository. Global patterns are supported and can include multiple files. |
183
+
|configurationfile| Yes | Path to the configuration file in the repository, relative to the root of the repository. Glob patterns are supported and can include multiple files. |
184
184
| format | Yes | File format of the configuration file. Valid formats are: JSON, YAML, properties. |
185
-
|connectionString| Yes | Connection string for the App Configuration instance. The connection string should be stored as a secret in the GitHub repository, and only the secret name should be used in the workflow. |
185
+
|connectionstring| Yes | Connection string for the App Configuration instance. The connection string should be stored as a secret in the GitHub repository, and only the secret name should be used in the workflow. |
186
186
| separator | Yes | Separator used when flattening the configuration file to key-value pairs. Valid values are: . , ; : - _ __ / |
187
187
| prefix | No | Prefix to be added to the start of keys. |
188
188
| label | No | Label used when setting key-value pairs. If unspecified, a null label is used. |
189
-
| strict | No | A boolean value that determines whether strict mode is enabled. The default value is false. See below for more information about strict mode. |
189
+
| strict | No | A boolean value that determines whether strict mode is enabled. The default value is false. |
190
190
| depth | No | Max depth for flattening the configuration file. Depth must be a positive number. The default will have no max depth. |
191
191
| tags | No | Specifies the tag set on key-value pairs. The expected format is a stringified form of a JSON object of the following shape: { [propertyName: string]: string; } Each property name-value becomes a tag. |
192
192
193
193
## Next steps
194
194
195
-
In this article, you learned about the App Configuration Sync GitHub Action and how it can be used to automate updates to your App Configuration store. To learn how Azure App Configuration reacts to changes in key-value pairs, continue to the next [article](./concept-app-configuration-event.md).
195
+
In this article, you learned about the App Configuration Sync GitHub Action and how it can be used to automate updates to your App Configuration instance. To learn how Azure App Configuration reacts to changes in key-value pairs, continue to the next [article](./concept-app-configuration-event.md).
0 commit comments