Skip to content

Commit 6e4d2bc

Browse files
committed
docs: add CI/CD docs for forked repos (fixes #111)
1 parent 3e47fcf commit 6e4d2bc

File tree

2 files changed

+24
-13
lines changed

2 files changed

+24
-13
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,18 @@ You can now open the web app in your browser and start chatting with the bot.
143143

144144
When deploying the sample in an enterprise context, you may want to enforce tighter security restrictions to protect your data and resources. See the [enhance security](./docs/enhance-security.md) guide for more information.
145145

146+
#### Enable CI/CD
147+
148+
If you want to enable Continuous Deployment for your forked repository, you need to configure the Azure pipeline first:
149+
150+
1. Open a terminal at the root of your forked project.
151+
2. Authenticate with Azure by running `azd auth login`.
152+
3. Run `azd pipeline config` to configure the required secrets and variables for connecting to Azure from GitHub Actions.
153+
- This command will set up the necessary Azure service principal and configure GitHub repository secrets.
154+
- Follow the prompts to complete the configuration.
155+
156+
Once configured, the GitHub Actions workflow will automatically deploy your application to Azure whenever you push changes to the main branch.
157+
146158
#### Clean up
147159

148160
To clean up all the Azure resources created by this sample:

docs/readme.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -59,19 +59,6 @@ You can run this project directly in your browser by using GitHub Codespaces, wh
5959
![Screenshot showing how to create a new codespace](./images/codespaces.png)
6060
3. Wait for the Codespace to be created, it should take a few minutes.
6161

62-
## Enable CI/CD (Optional)
63-
64-
If you want to enable Continuous Deployment for your forked repository, you need to configure the Azure pipeline first:
65-
66-
1. Make sure you have the [Azure Developer CLI](https://aka.ms/azure-dev/install) installed.
67-
2. Open a terminal at the root of your forked project.
68-
3. Authenticate with Azure by running `azd auth login`.
69-
4. Run `azd pipeline config` to configure the required secrets and variables for connecting to Azure from GitHub Actions.
70-
- This command will set up the necessary Azure service principal and configure GitHub repository secrets.
71-
- Follow the prompts to complete the configuration.
72-
73-
Once configured, the GitHub Actions workflow will automatically deploy your application to Azure whenever you push changes to the main branch.
74-
7562
## Deploy on Azure
7663

7764
1. Open a terminal at the root of the project.
@@ -86,6 +73,18 @@ The deployment process will take a few minutes. Once it's done, you'll see the U
8673

8774
You can now open the web app in your browser and start chatting with the bot.
8875

76+
## Enable CI/CD (Optional)
77+
78+
If you want to enable Continuous Deployment for your forked repository, you need to configure the Azure pipeline first:
79+
80+
1. Open a terminal at the root of your forked project.
81+
2. Authenticate with Azure by running `azd auth login`.
82+
3. Run `azd pipeline config` to configure the required secrets and variables for connecting to Azure from GitHub Actions.
83+
- This command will set up the necessary Azure service principal and configure GitHub repository secrets.
84+
- Follow the prompts to complete the configuration.
85+
86+
Once configured, the GitHub Actions workflow will automatically deploy your application to Azure whenever you push changes to the main branch.
87+
8988
## Key concepts
9089

9190
Our API is composed of two main endpoints:

0 commit comments

Comments
 (0)