Add instructions for creating YAML based image definition files for dev box #144
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive instructions for creating YAML-based image definition files for Microsoft Dev Box Team Customizations. The instructions provide guidance on using Dev Box tooling, applying best practices from official documentation, and troubleshooting common issues.
Key changes:
- Adds detailed authoring guidelines for Dev Box image definition files
- Includes critical workflow steps for checking tool availability and customization tasks
- Provides security guidance for handling secrets with Azure Key Vault
- Documents troubleshooting approaches and common issues
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| instructions/devbox-image-definition.instructions.md | New comprehensive instruction file covering Dev Box image definition authoring, tool usage, security practices, and troubleshooting |
| README.md | Adds table entry for the new Dev Box image definitions instruction file |
aaronpowell
approved these changes
Aug 6, 2025
|
|
||
| **If tools are NOT available:** | ||
|
|
||
| - Recommend that the user enable the [dev box tools](https://learn.microsoft.com/azure/dev-box/how-to-use-copilot-generate-image-definition-file) |
There was a problem hiding this comment.
you could have it offer to install the tools too
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This request add instructions to aid in generating YAML based image definition files for use with Microsoft Dev Box Team Customizations.
Pull Request Checklist
node update-readme.jsand verified thatREADME.mdis up to date.Description
Comprehensive authoring guidelines for generating YAML based image definition files that can be used with Microsoft Dev Box Team Customizations. The instructions focus on helping to setup and use available Dev Box tooling, applying recommendations from official documentation, and highlighting common issues and troubleshooting suggestions.
Type of Contribution
Additional Notes
None
By submitting this pull request, I confirm that my contribution abides by the Code of Conduct and will be licensed under the MIT License.