Skip to content

Commit afef69a

Browse files
committed
Freshness pass on Github Action conceptual article
1 parent 9e2407d commit afef69a

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

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

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,34 @@ description: Use GitHub Actions to trigger an update to your App Configuration i
44
author: lisaguthrie
55

66
ms.author: lcozzens
7-
ms.date: 01/14/2020
7+
ms.date: 02/20/2020
88
ms.topic: conceptual
99
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. 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.
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.
1414

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.
15+
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

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.
17+
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. 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.
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.
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

2323
## Enable GitHub Actions in your repository
24-
To start using this GitHub action, go to your repository and select the **Actions** tab. Click on New workflow” and then Set up a workflow yourself”. From there, search the marketplace for “Azure App Configuration Sync.”
24+
To start using this GitHub action, go to your repository and select the **Actions** tab. Click on **New workflow**, then **Set up a workflow yourself**. Finally, search the marketplace for “Azure App Configuration Sync.”
2525
> [!div class="mx-imgBorder"]
2626
> ![Select the Action tab](media/find-github-action.png)
2727
2828
> [!div class="mx-imgBorder"]
2929
> ![Select the app configuration syn Action](media/app-configuration-sync-action.png)
3030
3131
## Sync configuration files after a push
32-
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+
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 [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+
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,7 +58,7 @@ jobs:
5858
```
5959

6060
## Use a dynamic label on sync
61-
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+
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.
6262

6363
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.
6464

@@ -139,6 +139,7 @@ The default behavior for nested JSON attributes is to flatten the entire object.
139139
}
140140
}
141141
```
142+
142143
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.
143144

144145
```json

0 commit comments

Comments
 (0)