Feat: Add GitHub Copilot Quickstart Guide - WIP #2231
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added GitHub Copilot and related extensions to the devcontainer configuration. - Created a new documentation page for using AVM with GitHub Copilot. - Included setup instructions and productivity tips for AVM module development.
- Revised introduction to clarify how GitHub Copilot enhances productivity with Azure Verified Modules (AVM). - Expanded list of areas where GitHub Copilot can assist in Infrastructure as Code (IaC) development.
microsoft-github-policy-service
bot
added
the
Needs: Triage 🔍
- Updated sections to include detailed usage scenarios for GitHub Copilot with AVM. - Added new topics on configuring MCP servers, adding prompt files, and modes. - Improved clarity and structure for better user guidance.
- Added GitHub Copilot Chat and GitHub Copilot for Azure extensions to the devcontainer configuration. - Created a new MCP configuration file for GitHub Copilot. - Updated documentation to reflect changes in setting up the environment for GitHub Copilot.
- Reformatted JSON structure in mcp.json for consistency. - Updated GitHub Copilot usage documentation for clarity.
- Added `github-copilot-prompt-file-install-location.png` to illustrate the installation location for GitHub Copilot prompts. - Added `github-copilot-prompt-file-install-name.png` to demonstrate the naming conventions for GitHub Copilot prompt files.
- Renamed section from "Configuring MCP Servers" to "Adding MCP Servers" - Added details on configuring MCP servers in Visual Studio Code - Included links to relevant Visual Studio Code documentation - Added a new section for "Instruction Files" with a note on availability
- Introduced custom chat modes for Bicep and Terraform in GitHub Copilot. - Added installation instructions and links to the Awesome-Copilot repository. - Enhanced documentation for using custom chat modes in Visual Studio Code.
jtracey93
added
Status: Do Not Merge ⛔
jtracey93
requested changes
Aug 1, 2025
| @@ -0,0 +1,186 @@ | |||
| --- | |||
| draft: true | |||
Contributor
There was a problem hiding this comment.
we can remove this as im sure we'll forget before merging and then it wont appear 👍
Comment on lines
+110
to
+118
| <img src="{{% siteparam base %}}/images/usage/gh-copilot/github-copilot-chat-mode-install-confirm.png" alt="Confirm installation of Prompt File into VS Code" style="max-width:800px;" /> | ||
|
|
||
| 1. Select whether to install the custom chat mode into this workspace (`.github/chatmode/`) or into your global user account, making it available to every workspace you work on. | ||
|
|
||
| <img src="{{% siteparam base %}}/images/usage/quickstart/github-copilot/github-copilot-chat-mode-install-location.png" alt="Select scope of Prompt File" style="max-width:800px;" /> | ||
|
|
||
| 1. You can choose a name for the custom chat mode, or leave it as the default name. | ||
|
|
||
| <img src="{{% siteparam base %}}/images/usage/quickstart/github-copilot/github-copilot-chat-mode-install-name.png" alt="Select scope of Prompt File" style="max-width:800px;" /> |
Contributor
There was a problem hiding this comment.
Missing these images in the branch?
|
|
||
| ### Instruction Files | ||
|
|
||
| TBC - currently no AVM specific instruction files are available (there are TF and Bicep ones though) |
Contributor
There was a problem hiding this comment.
Actually what about the one in the BRM repo? in the other PR you have
Comment on lines
+184
to
+186
| ### Creating Documentation for Your AVM IaC | ||
|
|
||
| GitHub Copilot can also help you create documentation for your AVM IaC. For example, you can start by writing a comment or a function name, and GitHub Copilot will suggest documentation based on the context of your code. This can help you create consistent and comprehensive documentation for your AVM modules. |
Contributor
There was a problem hiding this comment.
Probably not one to add here as we have scripts and tools for both TF and Bicep to autogenerate this that is checked with our CI
|
|
||
| If you need to refactor existing AVM IaC to use different technologies or architectures, GitHub Copilot can help. For example, if you're moving to a zero trust architecture, you can start by modifying the existing code and GitHub Copilot will suggest changes based on the context of your modifications. | ||
|
|
||
| ### Updating Existing AVM Modules to Use the Latest Version |
Contributor
There was a problem hiding this comment.
Add a similar one for API versions, especially as we are promoting the use of azapi provider in TF as well now
Contributor
There was a problem hiding this comment.
feel like we need to split the docs/scenarios in to separate sections for
- AVM module owners
- AVM module consumers
As they both will use very differently
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview/Summary
Adds GitHub Copilot Quickstart Guide.
This PR fixes/adds/changes/removes
Using AVM with GitHub Copilotdocument (still in draft)Breaking Changes
N/A
As part of this Pull Request I have
mainbranch