Skip to content

Commit 8f25edf

Browse files
committed
Acrolinx fixes on GitHub Actions
1 parent 3003f60 commit 8f25edf

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

articles/azure-app-configuration/concept-github-action.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ ms.service: azure-app-configuration
1010

1111
---
1212
# 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. GitHub workflows can trigger app configuration updates, enabling the integration of those updates into the same workflow used to update the app code.
13+
Azure App Configuration uses GitHub Actions to trigger updates to an App Configuration instance based on actions performed on a GitHub repository. GitHub workflows trigger configuration updates, enabling the integration of those updates into the same workflow used to update the app code.
1414

1515
A GitHub Actions [workflow](https://help.github.com/articles/about-github-actions#workflow) defines an automated process in a 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.
1616

1717
A YAML (.yml) file found in the `/.github/workflows/` path of your repository defines your workflow. This definition contains the workflow's steps and parameters.
1818

19-
GitHub events, such as a push to a repository, can trigger a GitHub Action workflow. The *Azure App Configuration Sync* action enables you to trigger an update of an App Configuration instance when a specified GitHub action occurs. This allows you to leverage GitHub's core features when pushing, reviewing, or branching app configuration files just as you do with app code.
19+
GitHub events, such as a push to a repository, can trigger a GitHub Action workflow. The *Azure App Configuration Sync* action enables you to trigger an update of an App Configuration instance when a specified GitHub action occurs. You can trigger configuration updates when pushing, reviewing, or branching app configuration files just as you do with app code.
2020

2121
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.
2222

@@ -26,12 +26,12 @@ To start using this GitHub action, go to your repository and select the **Action
2626
> ![Select the Action tab](media/find-github-action.png)
2727
2828
> [!div class="mx-imgBorder"]
29-
> ![Select the app configuration syn Action](media/app-configuration-sync-action.png)
29+
> ![Select the app configuration sync Action](media/app-configuration-sync-action.png)
3030
3131
## Sync configuration files after a push
3232
This action syncs Azure App Configuration files when a change is pushed to `appsettings.json`. When a developer pushes a change to `appsettings.json`, the App Configuration Sync action updates the App Configuration instance with the new values.
3333

34-
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 [GitHub's article](https://help.github.com/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) about creating and using encrypted secrets.
34+
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 [GitHub's article](https://help.github.com/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) about creating and using encrypted secrets.
3535

3636
```json
3737
on:
@@ -58,9 +58,9 @@ jobs:
5858
```
5959

6060
## Use a dynamic label on sync
61-
The previous action updates 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+
The previous action updates 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 and allowing code changes to be mapped to config changes.
6262

63-
The first section of this workflow 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+
The first section of this workflow specifies that the action triggers *on* a *push* containing `appsettings.json` to the *master* branch. The second section runs a job that 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.
6464

6565
```json
6666
on:
@@ -92,9 +92,9 @@ jobs:
9292
```
9393

9494
## Use strict sync
95-
When strict mode is enabled, the sync ensures that the App Configuration instance matches the configuration file for the given prefix and label exactly. Key-value pairs with the same prefix and label that are not in the configuration file are deleted.
95+
When strict mode is enabled, the sync ensures that the App Configuration instance matches the configuration file for the given prefix and label exactly. Key-value pairs with the same prefix and label that aren't in the configuration file are deleted.
9696

97-
If strict mode is not enabled, the sync will only set key-values from the configuration file. No key-value pairs will be deleted.
97+
If strict mode isn't enabled, the sync will only set key-values from the configuration file. No key-value pairs will be deleted.
9898

9999
```json
100100
on:
@@ -167,7 +167,7 @@ jobs:
167167
depth: 2
168168
```
169169

170-
Given a depth of 2, the example above now returns the following key:value pair:
170+
Given a depth of 2, the example above now returns the following key-value pair:
171171

172172
| Key | Value |
173173
| --- | --- |
@@ -182,7 +182,7 @@ Input parameters specify data used by the action during runtime. The following
182182

183183
| Input name | Required? | Value |
184184
|----|----|----|
185-
| 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. |
185+
| configurationFile | Yes | Relative path to the configuration file in the repository. Glob patterns are supported and can include multiple files. |
186186
| format | Yes | File format of the configuration file. Valid formats are: JSON, YAML, properties. |
187187
| 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. |
188188
| separator | Yes | Separator used when flattening the configuration file to key-value pairs. Valid values are: . , ; : - _ __ / |

0 commit comments

Comments
 (0)