Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 27, 2025

This PR adds a GitHub Actions workflow file that implements the required Copilot setup steps for the Onchain Test Kit repository.

What's Changed

  • Created .github/workflows/copilot-setup-steps.yml with the exact configuration needed for GitHub Copilot integration
  • The workflow is named "Copilot Setup Steps" and includes the required job name copilot-setup-steps
  • Configured proper triggers for automatic validation and manual testing

Workflow Features

The workflow automatically runs when:

  • Manual execution: Available through the repository's "Actions" tab via workflow_dispatch
  • Workflow changes: Triggers on push/PR when the workflow file itself is modified for easy validation

Setup Steps Included

The workflow performs the essential setup steps for the project:

  1. Code checkout using actions/checkout@v5
  2. Node.js setup with version 20 and npm caching using actions/setup-node@v4
  3. Dependency installation using npm ci for consistent, reproducible builds

Security & Permissions

  • Uses minimal permissions (contents: read) as recommended
  • Runs on ubuntu-latest for consistency with project requirements
  • Follows GitHub Actions security best practices

Validation

The workflow has been validated to ensure:

  • ✅ YAML syntax is correct
  • ✅ All setup steps execute successfully
  • ✅ Project builds and lints without errors after dependency installation
  • ✅ Meets all requirements specified for Copilot integration

This workflow enables GitHub Copilot to have a properly configured environment with all necessary dependencies installed before any agent operations begin, ensuring reliable and consistent execution of Copilot tasks within this blockchain testing toolkit repository.

Original prompt

.github/copilot-instructions name: "Copilot Setup Steps"

Automatically run the setup steps when they are changed to allow for easy validation, and

allow manual testing through the repository's "Actions" tab

on:
workflow_dispatch:
push:
paths:
- .github/workflows/copilot-setup-steps.yml
pull_request:
paths:
- .github/workflows/copilot-setup-steps.yml

jobs:

The job MUST be called copilot-setup-steps or it will not be picked up by Copilot.

copilot-setup-steps:
runs-on: ubuntu-latest

# Set the permissions to the lowest permissions possible needed for your steps.
# Copilot will be given its own token for its operations.
permissions:
  # If you want to clone the repository as part of your setup steps, for example to install dependencies, you'll need the `contents: read` permission. If you don't clone the repository in your setup steps, Copilot will do this for you automatically after the steps complete.
  contents: read

# You can define any steps you want, and they will run before the agent starts.
# If you do not check out your code, Copilot will do this for you.
steps:
  - name: Checkout code
    uses: actions/checkout@v5

  - name: Set up Node.js
    uses: actions/setup-node@v4
    with:
      node-version: "20"
      cache: "npm"

  - name: Install JavaScript dependencies
    run: npm ci

💡 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.

Copilot AI changed the title .github/copilot-instructions name: "Copilot Setup Steps" # Automatically run the setup steps when they are changed to allow for easy validation, and # allow manual testing through the repository's "Actions" tab on: workflow_dispatch: push: pat... Add GitHub Actions Copilot setup steps workflow Sep 27, 2025
Copilot AI requested a review from joe10832 September 27, 2025 21:31
Copy link
Member

@joe10832 joe10832 left a comment

Choose a reason for hiding this comment

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

Copy link
Member

@joe10832 joe10832 left a comment

Choose a reason for hiding this comment

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

@joe10832 joe10832 marked this pull request as ready for review September 27, 2025 21:44
Copilot AI review requested due to automatic review settings September 27, 2025 21:44
Copilot AI requested a review from joe10832 September 27, 2025 21:44
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

@copilot <issue_title>copilot-setup-steps</issue_title>
<issue_description>/.github/copilot-instructions.md
/.github/instructions/**/.instructions.md
/AGENTS.md
/CLAUDE.md
/GEMINI.md</issue_description>/.github/copilot-instructions.md
/.github/instructions/
/
.instructions.md
**/AGENTS.md
/CLAUDE.md
/GEMINI.md@copilot ## Pull Request Overview

This PR adds a GitHub Actions workflow to provide proper environment setup for GitHub Copilot operations. The workflow ensures all project dependencies are installed and the environment is properly configured before Copilot agents begin execution.

Key changes:

  • Created GitHub Actions workflow with required copilot-setup-steps job name
  • Configured automatic triggers for workflow validation and manual testing
  • Implemented essential setup steps including Node.js configuration and dependency installation

Copy link
Member

@joe10832 joe10832 left a comment

Choose a reason for hiding this comment

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

Copy link
Member

@joe10832 joe10832 left a comment

Choose a reason for hiding this comment

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

@joe10832 joe10832 merged commit 65b5761 into main Sep 27, 2025
7 of 8 checks passed
Copilot AI requested a review from joe10832 September 27, 2025 21:49
Copy link
Member

@joe10832 joe10832 left a comment

Choose a reason for hiding this comment

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

Copy link
Member

@joe10832 joe10832 left a comment

Choose a reason for hiding this comment

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

@copilot <issue_title>✨ Set up Copilot instructions</issue_title>
<issue_description>Configure instructions for this repository as documented in Best practices for Copilot coding agent in your repository.

</issue_description>/.github/copilot-instructions.md
/.github/instructions/**/.instructions.md
/AGENTS.md
/CLAUDE.md
/GEMINI.md<issue_title>copilot-setup-steps</issue_title>
<issue_description>/.github/copilot-instructions.md
/.github/instructions/
/
.instructions.md
**/AGENTS.md
/CLAUDE.md
/GEMINI.md</issue_description>@copilot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment