Skip to content

Commit dbb41aa

Browse files
Copilotsinedied
andauthored
docs: add CI/CD docs for forked repos (fixes #111)
* Initial plan * Add documentation for configuring CI/CD after forking Co-authored-by: sinedied <[email protected]> * docs: add CI/CD docs for forked repos (fixes #111) --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: sinedied <[email protected]> Co-authored-by: Yohan Lasorsa <[email protected]>
1 parent 86b94f9 commit dbb41aa

File tree

2 files changed

+24
-0
lines changed

2 files changed

+24
-0
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 & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,18 @@ The deployment process will take a few minutes. Once it's done, you'll see the U
7373

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

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+
7688
## Key concepts
7789

7890
Our API is composed of two main endpoints:

0 commit comments

Comments
 (0)