Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 13, 2025

Create comprehensive build and test instructions document based on build.new.ps1 and workflows

Summary

Added a comprehensive instructions.md file that provides detailed documentation for building and testing the DSC project. This document serves as a reference for contributors to validate changes before submitting pull requests.

Location: .github/instructions/instructions.md (for GitHub Copilot)

What's Included

Prerequisites: Lists required and automatically-installed dependencies
Build Instructions: Debug, release, and cross-platform build commands
Test Execution: Complete guide for Rust and Pester tests, including specific test groups
Linting: Clippy usage and security audit instructions
Package Creation: Instructions for creating MSIX, ZIP, and TGZ packages
CI/CD Overview: Explains GitHub Actions workflows and how to simulate CI locally
Troubleshooting: Common issues and solutions
Parameter Reference: Complete table of all build.new.ps1 parameters
Validation Guide: Steps to validate changes before submitting PRs

Changes

  • Created comprehensive instructions.md documentation
  • Verified build and test procedures work correctly
  • Moved instructions.md to .github/instructions/ folder per feedback

Verification

  • Successfully built the project using instructions
  • Verified GetPackageVersion parameter works (returns 3.2.0-preview.8)
  • Confirmed build artifacts are created in bin/debug/
  • Tested dsc binary runs successfully
  • Documentation is clear and comprehensive
  • No security issues (documentation-only change)
  • File properly located in .github/instructions/ for GitHub Copilot
Original prompt

looks at the build.new.ps1 script, the workflows and actions and create an instructions.md file on how to build and execute tests. These instructions should be used to validate changes done by co-pilot for change in the future.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: adityapatwardhan <12820925+adityapatwardhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add instructions for building and executing tests Add instructions.md for building and testing DSC Nov 13, 2025
Copilot finished work on behalf of adityapatwardhan November 13, 2025 18:16
@adityapatwardhan
Copy link
Member

@copilot This instrunctions.md is targeted towards GitHub copilot, please move it under .github/instructions folder

Co-authored-by: adityapatwardhan <12820925+adityapatwardhan@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 13, 2025

@copilot This instrunctions.md is targeted towards GitHub copilot, please move it under .github/instructions folder

Moved to .github/instructions/instructions.md in commit 8c24572.

Copilot finished work on behalf of adityapatwardhan November 13, 2025 18:31
@adityapatwardhan adityapatwardhan marked this pull request as ready for review November 13, 2025 18:33
@SteveL-MSFT SteveL-MSFT added this pull request to the merge queue Nov 14, 2025
Merged via the queue into main with commit de79d34 Nov 14, 2025
23 checks passed
@SteveL-MSFT SteveL-MSFT deleted the copilot/add-instructions-for-building-tests branch November 14, 2025 00:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants