Development

[nam20485]

No description provided.

[Copilot]

Pull Request Overview

This pull request implements a comprehensive development environment setup system for ASP.NET Core + Blazor + Google Cloud development. The PR adds automated scripts for local environment validation and setup, alongside GitHub Actions workflows and devcontainer configurations to ensure consistent development environments across all platforms.

Key Changes:

• PowerShell-based local environment setup and validation scripts with cross-platform support
• GitHub Actions workflow for automated environment validation using prebuild devcontainer images
• Devcontainer configurations for both prebuild image creation and local development
• AI workflow assignment for test case creation tasks

Reviewed Changes

Copilot reviewed 11 out of 12 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
scripts/validate-local-environment.ps1	Environment validation script with multiple output formats and comprehensive tool checking
scripts/setup-local-environment.ps1	Automated setup script for all required development tools across Windows/Linux/macOS
scripts/quick-setup.ps1	Fast-path setup script with intelligent validation and setup decisions
scripts/README.md	Comprehensive documentation for all environment scripts and usage patterns
ai_instruction_modules/ai-workflow-assignments/create-test-cases.md	New workflow assignment for systematic test case creation
ai_instruction_modules/ai-workflow-assignments.md	Updated index to include the new test case creation assignment
.github/workflows/prebuild.yml	Workflow for building and publishing prebuild devcontainer images
.github/workflows/copilot-setup-steps.yml	GitHub Actions workflow using prebuild images for faster CI/CD
.github/.devcontainer/devcontainer.json	Devcontainer configuration for prebuild image creation
.github/.devcontainer/Dockerfile	Multi-stage Dockerfile installing all development tools
.devcontainer/devcontainer.json	Local devcontainer configuration using prebuild images

Comments suppressed due to low confidence (6)

scripts/validate-local-environment.ps1:35

• The .NET SDK version 9.0.102 may not exist or be generally available. Consider using a more stable version like 8.0.x LTS or verify this version exists in the Microsoft releases.

$EXPECTED_DOTNET = "9.0.102"

scripts/setup-local-environment.ps1:38

• The .NET SDK version 9.0.102 may not exist or be generally available. This could cause installation failures across all platforms. Consider using a stable LTS version like 8.0.x.

$DOTNET_VERSION = "9.0.102"

scripts/setup-local-environment.ps1:319

• Function name 'Install-NodeJs' is inconsistent with the actual function name 'Install-NodeJS' (line 149). This will cause a runtime error.

            Install-NodeJs -Force:$Force

.github/workflows/copilot-setup-steps.yml:23

• The devcontainer image name format is inconsistent with the actual image name used in the prebuild workflow. The prebuild workflow uses 'nam20485/agent-instructions-prebuild' while this references '${{ github.repository }}-devcontainer'.

  DEVCONTAINER_IMAGE: "ghcr.io/${{ github.repository }}-devcontainer:latest"

.github/workflows/copilot-setup-steps.yml:30

• Container image reference is inconsistent with the prebuild workflow which creates 'nam20485/agent-instructions-prebuild' image. This mismatch will cause the workflow to fail.

      image: ghcr.io/${{ github.repository }}-devcontainer:latest

.github/.devcontainer/Dockerfile:6

• The base image version '1.3.7-9.0-bookworm-slim' may not exist. .NET 9.0 was released recently and this specific devcontainer version might not be available. Consider using a stable version like '1-8.0-bookworm-slim'.

FROM mcr.microsoft.com/devcontainers/dotnet:1.3.7-9.0-bookworm-slim

[gemini-code-assist]

Summary of Changes

Hello @nam20485, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the development workflow by establishing a standardized and automated development environment. It provides robust tools for both local machine setup and VS Code Dev Containers, ensuring consistency across different development contexts. Additionally, it introduces a new AI agent assignment aimed at improving code quality through comprehensive automated testing.

Highlights

• Standardized Development Environment: I've introduced comprehensive Dev Container configurations, including a custom Dockerfile, to provide a consistent, pre-configured development environment. This setup is tailored for .NET, Node.js, Google Cloud, and AI development, integrating a wide array of VS Code extensions and essential tools.
• Automated Environment Setup & Validation: I've added cross-platform PowerShell scripts to automate the installation, configuration, and validation of the local development environment. These scripts ensure consistency with the Dev Container and GitHub Actions workflows, streamlining developer onboarding and environment maintenance.
• New AI Agent Assignment for Testing: I've expanded the AI agent instruction modules with a new assignment focused on systematically increasing automated test coverage. This includes detailed guidance for AI agents on planning, obtaining approval, implementing unit and integration tests, and integrating them into CI pipelines.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments or fill out our survey to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a comprehensive development environment setup, including devcontainer configurations, setup scripts, and new AI instruction modules. The changes are extensive and form a solid foundation for standardized development.

My review focuses on improving the correctness and efficiency of the new configurations and scripts. I've identified some critical issues, such as a conflicting Docker setup in the devcontainer.json files and a bug in the PowerShell setup script that could terminate it prematurely. I've also suggested optimizations for the Dockerfile to improve build times and maintainability, along with several corrections for the documentation files.

Addressing these points will significantly improve the robustness and clarity of the development environment. Thank you for this contribution!

[gemini-code-assist]

Using exec -l $SHELL will replace the current script's process with a new shell, which will prematurely terminate the script at this point. The Google Cloud SDK installer suggests this to refresh the PATH, but it's not safe to use within a script.

A better approach would be to inform the user that they need to restart their shell session after the script completes for the gcloud command to be available in their PATH.

            # The user will need to restart their shell for gcloud to be in the PATH.
            # The installer modifies shell profile files (e.g., .bashrc, .zshrc).

[gemini-code-assist]

This mounts configuration for the Docker socket creates a conflict with the docker-in-docker feature enabled on lines 8-11.

• The docker-in-docker feature provides an isolated Docker daemon inside the container.
• Mounting the host's Docker socket (/var/run/docker.sock) provides access to the host's Docker daemon (a pattern known as Docker-out-of-Docker).

Using both at the same time is confusing and can lead to unpredictable behavior. To align with the explicit use of the docker-in-docker feature, I recommend removing this mount. If access to the host's Docker daemon is intended, you should use the docker-from-docker feature instead and remove the docker-in-docker one.

[gemini-code-assist]

This mounts configuration for the Docker socket creates a conflict with the docker-in-docker feature enabled on lines 18-20.

• The docker-in-docker feature provides an isolated Docker daemon inside the container.
• Mounting the host's Docker socket (/var/run/docker.sock) provides access to the host's Docker daemon (a pattern known as Docker-out-of-Docker).

Using both at the same time is confusing and can lead to unpredictable behavior. To align with the explicit use of the docker-in-docker feature, I recommend removing this mount. If access to the host's Docker daemon is intended, you should use the docker-from-docker feature instead and remove the docker-in-docker one.

[gemini-code-assist]

This link to copilot-setup-steps.yml appears to be broken, as the file does not exist in the repository. Please update it to point to the correct file or remove the link if it's no longer relevant.

[gemini-code-assist]

The current approach of installing each tool with separate RUN commands, each containing apt-get update, is inefficient. It increases the Docker image size by creating multiple layers and slows down the build process.

It's a best practice to consolidate these installations. You can add all external package sources first, then run apt-get update once, and finally install all the tools in a single apt-get install command. This will result in a smaller, faster-building, and more maintainable Dockerfile.

RUN curl -fsSL https://deb.nodesource.com/setup_22.x | bash - \
    && wget -q "https://packages.microsoft.com/config/debian/12/packages-microsoft-prod.deb" \
    && dpkg -i packages-microsoft-prod.deb \
    && rm packages-microsoft-prod.deb \
    && echo "deb [signed-by=/usr/share/keyrings/cloud.google.gpg] https://packages.cloud.google.com/apt cloud-sdk main" | tee /etc/apt/sources.list.d/google-cloud-sdk.list > /dev/null \
    && curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | gpg --dearmor -o /usr/share/keyrings/cloud.google.gpg \
    && curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
    && chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
    && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
    && wget -O- https://apt.releases.hashicorp.com/gpg | gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg \
    && echo "deb [signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | tee /etc/apt/sources.list.d/hashicorp.list > /dev/null \
    && apt-get update \
    && apt-get install -y nodejs powershell google-cloud-cli gh terraform \
    && npm install -g npm@latest \
    && rm -rf /var/lib/apt/lists/*

[gemini-code-assist]

This sentence is unprofessional and doesn't fit in a technical instruction document. I recommend removing it to maintain a professional tone.

[gemini-code-assist]

The acceptance criteria are not numbered sequentially, which makes them difficult to follow. Please reorder and renumber them for clarity.

Suggested change

	1. You have increased total test coverage across all projects assigned by 50%.
	2. Test Projects for each code project have been created.
	6. All projects build and runs successfully.
	8. All test cases pass 100%.
	7. All acceptance criteria from the template have been satisfied
	4. Application follows the specified technology stack and design principles
	1. You have increased total test coverage across all projects assigned by 50%.
	2. Test Projects for each code project have been created.
	3. Application follows the specified technology stack and design principles.
	4. All projects build and run successfully.
	5. All test cases pass 100%.
	6. All acceptance criteria from the template have been satisfied.

[gemini-code-assist]

There's a typo in the word "automated".

Suggested change

* [create-test-cases.md](create-test-cases.md): This assignment involves creating test cases for the application, ensuring that all critical functionality is covered and that the tests are properly integrated into the build process. You will create a plan, document it in an issue, and once gaining approval, you will implement the plan. You will also create (or upgrade, if necessary) an auomated test pipeline.

* [create-test-cases.md](create-test-cases.md): This assignment involves creating test cases for the application, ensuring that all critical functionality is covered and that the tests are properly integrated into the build process. You will create a plan, document it in an issue, and once gaining approval, you will implement the plan. You will also create (or upgrade, if necessary) an automated test pipeline.

[gemini-code-assist]

Using a long chain of echo commands to create a script is hard to read and maintain. A heredoc would be much cleaner and easier to manage.

RUN echo '#!/bin/bash' > /home/vscode/show-env.sh && \
    cat <<'EOF' >> /home/vscode/show-env.sh
echo "=== AI Agent Instructions Development Environment ==="
echo "Core Development Stack:"
echo "- .NET SDK: $(dotnet --version)"
echo "- Node.js: $(node --version)"
echo "- npm: $(npm --version)"
echo "- Python: $(python --version)"
echo "- PowerShell: $(pwsh --version)"
echo ""
echo "Cloud & DevOps Tools:"
echo "- Google Cloud CLI: $(gcloud version --format=\"value(Google Cloud SDK)\" 2>/dev/null || echo \"Not authenticated\")"
echo "- Firebase CLI: $(firebase --version)"
echo "- GitHub CLI: $(gh --version | head -1)"
echo "- Terraform: $(terraform --version | head -1)"
echo ""
echo "AI Development Tools:"
echo "- Gemini CLI: $(gemini --version 2>/dev/null || echo \"Available\")"
echo ""
echo "Ready for ASP.NET Core + Blazor + AI + Google Cloud development!"
EOF
RUN chmod +x /home/vscode/show-env.sh

[gemini-code-assist]

To optimize the Docker image and reduce the number of layers, you can combine these npm install -g commands into a single RUN instruction.

RUN npm install -g \
    firebase-tools \
    @angular/cli \
    create-react-app \
    typescript \
    eslint \
    prettier