Skip to content

Commit bca00e8

Browse files
Merge pull request #7594 from alexwolfmsft/cicd-updates
Content freshness pass
2 parents 263aaca + e2639d1 commit bca00e8

File tree

1 file changed

+54
-28
lines changed

1 file changed

+54
-28
lines changed

articles/azure-developer-cli/pipeline-github-actions.md

Lines changed: 54 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: Configure a pipeline using GitHub Actions
3-
description: Learn how to create a pipeline and push updates using GitHub Actions and the Azure Developer CLI
3+
description: Learn how to create a pipeline and push updates using GitHub Actions and the Azure Developer CLI.
44
author: alexwolfmsft
55
ms.author: alexwolf
6-
ms.date: 05/12/2025
6+
ms.date: 07/29/2025
77
ms.service: azure-dev-cli
88
ms.topic: how-to
99
ms.custom: devx-track-azdevcli, build-2023
@@ -18,12 +18,14 @@ In this article, you'll learn how to use the Azure Developer CLI (`azd`) to crea
1818
1919
## Prerequisites
2020

21-
- [Install the Azure Developer CLI](install-azd.md).
22-
- [Visual Studio Code](https://code.visualstudio.com/download) installed.
21+
- [Install the Azure Developer CLI](install-azd.md)
22+
- [Visual Studio Code](https://code.visualstudio.com/download) (optional, for editing files)
23+
- A GitHub account
24+
- An Azure subscription
2325

2426
## Initialize the template
2527

26-
This example uses the [Hello-AZD](https://github.com/azure-samples/hello-azd) template, but you can follow these steps for any template that includes a pipeline definition file (typically found in the `.github` or `.azdo` folders).
28+
This example uses the [Hello-AZD](https://github.com/azure-samples/hello-azd) template, but you can follow these steps for any `azd` template that includes a pipeline definition file (typically found in the `.github` or `.azdo` folders).
2729

2830
1. In an empty directory, initialize the `hello-azd` template:
2931

@@ -33,7 +35,7 @@ This example uses the [Hello-AZD](https://github.com/azure-samples/hello-azd) te
3335

3436
1. When prompted, enter a name for the environment, such as *helloazd*.
3537

36-
### Create a pipeline using GitHub Actions
38+
## Create a pipeline using GitHub Actions
3739

3840
Follow these steps to create and configure a pipeline:
3941

@@ -43,7 +45,26 @@ Follow these steps to create and configure a pipeline:
4345
azd pipeline config
4446
```
4547

46-
1. Provide the requested GitHub information.
48+
1. When prompted to select a provider, choose **GitHub**.
49+
50+
```output
51+
? Select a provider: [Use arrows to move, type to filter]
52+
> GitHub
53+
Azure DevOps
54+
```
55+
56+
1. Select your desired Azure subscription and region.
57+
58+
1. When prompted to configure your remote repository, choose **Create a new private GitHub repository**. If you have an existing project you'd like to use, you can also choose **Select an existing GitHub project**.
59+
60+
```azdeveloper
61+
? How would you like to configure your git remote to GitHub? [Use arrows to move, type to filter]
62+
Select an existing GitHub project
63+
> Create a new private GitHub repository
64+
Enter a remote URL directly
65+
```
66+
67+
1. Enter a name for the new repository.
4768
4869
1. When prompted to commit and push your local changes to start a new GitHub Actions run, enter `y`.
4970
@@ -62,51 +83,56 @@ Follow these steps to create and configure a pipeline:
6283
6384
:::image type="content" source="media/configure-devops-pipeline/github-workflow.png" alt-text="Screenshot of GitHub workflow running.":::
6485
65-
### Push a code change
86+
## Test the pipeline with a code change
6687
6788
1. In the project's `/src/components/pages` directory, open `Home.razor`.
68-
2. Locate the `Hello AZD!` header text near the top of the file.
69-
3. Change the text to `Hello, pipeline!`.
70-
4. Save the file.
71-
5. Commit and push your change. This triggers the GitHub Actions pipeline to deploy the update.
89+
1. Locate the `Hello AZD!` header text near the top of the file.
90+
1. Change the text to `Hello, pipeline!`.
91+
1. Save the file.
92+
1. Commit and push your change. This action triggers the GitHub Actions pipeline to deploy the update.
7293
7394
:::image type="content" source="media/configure-devops-pipeline/commit-changes-to-github.png" alt-text="Screenshot of steps required to make and commit change to test file.":::
7495
75-
6. In your browser, open your project's GitHub repository to see:
96+
1. In your browser, open your project's GitHub repository to see:
7697
- Your commit
77-
- The commit from GitHub Actions being set up
98+
- The commit from GitHub Actions setup
7899
79100
:::image type="content" source="media/configure-devops-pipeline/committed-changes-in-github-repo.png" alt-text="Screenshot of your committed change in GitHub.":::
80101
81-
7. Select **Actions** to see the test update reflected in the workflow.
102+
1. Select **Actions** to see the test update reflected in the workflow.
82103
83104
:::image type="content" source="media/configure-devops-pipeline/github-workflow-after-test-update.png" alt-text="Screenshot of GitHub workflow running after test update.":::
84105
85-
8. To view the update, visit the web frontend URL.
106+
1. To view the deployed update, visit the web frontend URL provided in the `azd` output.
86107
87-
### Use `azd` as a GitHub Action
108+
## Use `azd` as a GitHub Action
88109
89-
Install [`azd` as a GitHub Action](https://aka.ms/azd-gha). To use it, add the following to `.github/workflows/azure-dev.yml`:
110+
You can install `azd` as a GitHub Action using the [setup-azd action](https://github.com/Azure/setup-azd). To use it, add the following to your `.github/workflows/azure-dev.yml` file:
90111
91-
```yml
92-
on: [push]
112+
```yml
113+
on: [push]
93114
94-
jobs:
95-
build:
96-
runs-on: ubuntu-latest
97-
steps:
98-
- name: Install azd
99-
uses: Azure/[email protected]
100-
```
115+
jobs:
116+
build:
117+
runs-on: ubuntu-latest
118+
steps:
119+
- name: Install azd
120+
uses: Azure/[email protected]
121+
```
122+
123+
> [!NOTE]
124+
> Check the [setup-azd releases](https://github.com/Azure/setup-azd/releases) for the latest version number.
101125
102126
## Clean up resources
103127

104-
When you no longer need the Azure resources created in this article, run:
128+
When you no longer need the Azure resources created in this article, run the following command:
105129

106130
```azdeveloper
107131
azd down
108132
```
109133

134+
This command removes all Azure resources associated with your project.
135+
110136
## Next steps
111137

112138
> [!div class="nextstepaction"]

0 commit comments

Comments
 (0)