Skip to content

🔧 Add copilot-setup-steps.yml workflow for GitHub Copilot coding agent#253

Merged
chrisjsewell merged 5 commits intomainfrom
copilot/add-github-workflow-setup
Jan 16, 2026
Merged

🔧 Add copilot-setup-steps.yml workflow for GitHub Copilot coding agent#253
chrisjsewell merged 5 commits intomainfrom
copilot/add-github-workflow-setup

Conversation

Copy link
Contributor

Copilot AI commented Jan 16, 2026

Adds a GitHub Actions workflow that configures the development environment for GitHub Copilot coding agent following the official GitHub documentation.

Changes

  • Created .github/workflows/copilot-setup-steps.yml with setup steps for:

    • Python 3.11 with pip caching
    • Node.js 20 with npm caching (for SASS compilation)
    • uv for faster package management
    • pre-commit and pre-commit-uv
    • tox and tox-uv
    • Node.js dependencies via npm install
  • Workflow features:

    • Job named copilot-setup-steps (required for Copilot recognition)
    • Auto-triggers on workflow file changes for validation
    • Manually triggerable via workflow_dispatch
    • Explicit permissions (contents: read)
    • Follows GitHub's official Copilot setup workflow pattern

The workflow preinstalls development tools in Copilot's ephemeral environment before the agent starts working. Copilot handles cloning the repository and installing project dependencies itself.

Original prompt

Look into creating a .github/workflows/copilot-setup-steps.yml file, that includes setting up the necessary dev tools, like pre-commit, pre-commit-uv and tox and tox-uv


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits January 16, 2026 22:32
Co-authored-by: chrisjsewell <2997570+chrisjsewell@users.noreply.github.com>
Co-authored-by: chrisjsewell <2997570+chrisjsewell@users.noreply.github.com>
Copilot AI changed the title [WIP] Add GitHub workflow for Copilot setup steps Add copilot-setup-steps.yml workflow for development environment setup Jan 16, 2026
Copilot AI requested a review from chrisjsewell January 16, 2026 22:36
python -m pip install --upgrade pip

- name: Install uv (optional, for faster package management)
run: |
Copy link
Member

Choose a reason for hiding this comment

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

Do not install sphinx-design itself, only the development tools.

Also remove the verification job

Look at https://docs.github.com/en/copilot/how-tos/use-copilot-agents/coding-agent/customize-the-agent-environment#preinstalling-tools-or-dependencies-in-copilots-environment for guidance on how to write this file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated in commit f2f21c6:

  • Renamed job to copilot-setup-steps (required for Copilot recognition)
  • Removed sphinx-design project installation step
  • Removed verification step
  • Added workflow triggers for push/PR on file changes
  • Updated comments to match official GitHub documentation

Copilot AI and others added 2 commits January 16, 2026 22:43
…ct install and verification

Co-authored-by: chrisjsewell <2997570+chrisjsewell@users.noreply.github.com>
Co-authored-by: chrisjsewell <2997570+chrisjsewell@users.noreply.github.com>
Copilot AI changed the title Add copilot-setup-steps.yml workflow for development environment setup Add copilot-setup-steps.yml workflow for GitHub Copilot coding agent Jan 16, 2026
Copilot AI requested a review from chrisjsewell January 16, 2026 22:45
@chrisjsewell chrisjsewell changed the title Add copilot-setup-steps.yml workflow for GitHub Copilot coding agent 🔧 Add copilot-setup-steps.yml workflow for GitHub Copilot coding agent Jan 16, 2026
@chrisjsewell chrisjsewell marked this pull request as ready for review January 16, 2026 22:58
@chrisjsewell chrisjsewell requested a review from Copilot January 16, 2026 22:59
Copy link

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.

Pull request overview

This PR adds a GitHub Actions workflow to configure the development environment for GitHub Copilot coding agent, installing necessary development tools before the agent starts working.

Changes:

  • Created .github/workflows/copilot-setup-steps.yml with automated setup for Python, Node.js, and development tools
  • Configured the workflow to auto-trigger on workflow file changes and support manual execution
  • Set explicit minimal permissions for the workflow job

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chrisjsewell chrisjsewell merged commit 0b9c231 into main Jan 16, 2026
20 checks passed
@chrisjsewell chrisjsewell deleted the copilot/add-github-workflow-setup branch January 16, 2026 23:02
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.

2 participants