Skip to content

Add GitHub workflow for Copilot coding agent environment setup using pre-built container #2832

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 119 additions & 0 deletions .github/workflows/copilot-environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
name: Copilot Environment Setup

# This workflow sets up the development environment for GitHub Copilot coding agent
# It leverages the existing devcontainer configuration to ensure consistency
# with the development environment and avoid duplication of tooling setup
#
# The workflow:
# - Uses the same base container image as the devcontainer (mcr.microsoft.com/devcontainers/rust)
# - Runs the devcontainer post-create script for environment setup
# - Installs the same development tools specified in the devcontainer
# - Caches Cargo dependencies for improved performance
# - Runs comprehensive workspace verification (check, clippy, fmt)
# - Tests basic functionality to ensure the environment is ready
#
# This approach maintains consistency with the existing devcontainer setup
# and avoids maintaining duplicate tool installation logic
#
# Triggers:
# - Manual execution via workflow_dispatch
# - Weekly scheduled runs to keep environment fresh
# - Automatic runs when key configuration files change

on:
workflow_dispatch: # Allow manual triggering
schedule:
# Run weekly to keep the environment fresh
- cron: '0 2 * * 1' # Monday at 2 AM UTC
push:
branches: [main]
paths:
- 'rust-toolchain.toml'
- 'Cargo.toml'
- '.devcontainer/**'
- '.github/workflows/copilot-environment.yml'

jobs:
setup-environment:
name: Setup Copilot Coding Agent Environment
runs-on: ubuntu-latest
container:
image: mcr.microsoft.com/devcontainers/rust:1-1-bullseye

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup development environment using devcontainer configuration
run: |
# Run the devcontainer post-create script to set up the environment
# This uses the same setup as the existing devcontainer
chmod +x .devcontainer/oncreate
./.devcontainer/oncreate

- name: Install additional tools from devcontainer
run: |
# Install the same tools as specified in the devcontainer Dockerfile
cargo install cargo-watch http-server

# Install tools commonly needed for Rust development and Azure SDK
cargo install cargo-audit || echo "cargo-audit already installed or failed to install"
cargo install cargo-outdated || echo "cargo-outdated already installed or failed to install"

- name: Cache Cargo dependencies
uses: actions/cache@v4
with:
path: |
~/.cargo/bin/
~/.cargo/registry/index/
~/.cargo/registry/cache/
~/.cargo/git/db/
target/
key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
restore-keys: |
${{ runner.os }}-cargo-

- name: Verify workspace setup
run: |
# Verify the workspace can be built
cargo check --workspace --all-targets

# Run basic linting
cargo clippy --workspace --all-targets -- -D warnings

# Check formatting
cargo fmt --all -- --check

- name: Setup environment variables
run: |
echo "RUST_BACKTRACE=1" >> $GITHUB_ENV
echo "CARGO_TERM_COLOR=always" >> $GITHUB_ENV
echo "RUSTFLAGS=-D warnings" >> $GITHUB_ENV

- name: Test basic functionality
run: |
# Test that we can run basic cargo commands
cargo --version
cargo tree --workspace | head -20

# Verify that tests can be discovered
cargo test --workspace --no-run

- name: Environment summary
run: |
echo "=== Rust Environment Summary ==="
rustc --version
cargo --version
echo "=== Installed Components ==="
rustup component list --installed
echo "=== Available Tools ==="
which cargo-audit && cargo-audit --version || echo "cargo-audit not available"
which cargo-outdated && cargo-outdated --version || echo "cargo-outdated not available"
which cargo-watch && cargo-watch --version || echo "cargo-watch not available"
which http-server && http-server --version || echo "http-server not available"
echo "=== System Dependencies ==="
openssl version
pkg-config --exists openssl && echo "OpenSSL pkg-config: OK" || echo "OpenSSL pkg-config: NOT FOUND"
echo "=== Workspace Structure ==="
find . -name "Cargo.toml" | head -10
echo "=== Environment Ready for Copilot Coding Agent ==="
7 changes: 7 additions & 0 deletions .vscode/cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
"dotenv",
"downcasted",
"downcasting",
"dtolnay",
"entra",
"etag",
"eventhub",
Expand Down Expand Up @@ -153,6 +154,12 @@
"rust-custom"
]
},
{
"filename": ".github/workflows/*.yml",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot, just ignore this path instead. Remove this block and add the path to ignoredPaths above.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved GitHub workflow files to ignoredPaths instead of using dictionary override. Removed the workflow-specific override block and added .github/workflows/*.yml to the ignored paths list. Spell check now passes with no errors. (bd9b965)

"dictionaries": [
"rust-custom"
]
},
{
"filename": "sdk/core/azure_core_amqp/**",
"dictionaries": [
Expand Down
Loading