Skip to content

ci: configure Copilot cloud agent development environment - #240

Merged
rbell517 merged 2 commits into
masterfrom
agents/github-workflow-copilot-setup
Oct 29, 2026
Merged

rbell517 merged 2 commits into
masterfrom
agents/github-workflow-copilot-setup

Conversation

@rbell517

@rbell517 rbell517 commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

What does this Pull Request accomplish?

  • Adds GitHub's special copilot-setup-steps workflow to prepare an Ubuntu environment with Python 3.11 and Poetry 2.5.1.
  • Installs locked development dependencies, optional PyArrow, and Sphinx tooling in one shared Poetry environment. Documentation installation preserves installed locked versions, and the project remains editable.
  • Enables Poetry caching, read-only repository permissions, lightweight readiness checks, manual execution, and path-filtered pull request validation.
  • Documents the environment, validation commands, activation requirements, and integration-test limitations in the contributor guide.

Why should this Pull Request be merged?

Copilot cloud agents can start with the tools needed to develop, test, and build documentation without discovering and installing dependencies by trial and error.

The workflow uses Python 3.11 in preparation for the separate minimum-version update; this PR does not change the project's minimum Python version, lockfile, existing CI, or Read the Docs configuration. It does not expose integration or release credentials or run the full suite during every agent startup.

The setup applies to Copilot sessions running on GitHub Actions and must be merged into the default branch for normal activation.

What testing has been done?

Local validation used Windows and Python 3.10.11. The final workflow selects Python 3.11; a hosted Ubuntu/Python 3.11 workflow or agent session has not been run locally.

  • git diff --check and git diff --cached --check: passed.
  • Inline YAML assertions executed with .\.venv\Scripts\python.exe -: passed; verified the required job, supported settings, read-only permissions, path filters, Python 3.11, caching, absence of secrets/failure suppression, and matching contributor documentation.
  • .\.venv\Scripts\python.exe -m pip check: passed; no broken requirements.
  • .\.venv\Scripts\python.exe -m pytest tests -m '(not slow) and (not cloud) and (not enterprise)' -q: passed; 399 passed, 26 skipped, 278 deselected.
  • .\.venv\Scripts\sphinx-build.exe -b html docs 'C:\Users\rbell\.copilot\session-state\0a617ac6-2994-4519-95f1-7e0189b7c971\files\copilot-pr-docs-html': passed with 193 existing documentation warnings.
  • Earlier environment validation with Poetry 2.5.1 confirmed that documentation installation retains locked dependency versions, the root package remains editable, and development/PyArrow/Sphinx tools import successfully.

The existing poetry run poe test task encountered Windows marker-expression quoting trouble; the equivalent direct pytest selection above passed. Formatting, lint, type-checking, doctests, and credentialed integration suites were not rerun for these workflow/documentation changes.

Prepare Python 3.11 with locked development dependencies, optional PyArrow, and documentation tooling. Document environment usage and validation.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues were identified in the Copilot development-environment setup and documentation changes.

No open issues 🎉

What changed in this PR

Adds a reproducible development environment for Copilot cloud agents without changing the project's minimum Python version or existing CI configuration.

Changes:

  • Adds an Ubuntu setup workflow with Python 3.11, Poetry 2.5.1, caching, locked development dependencies, optional extras, and documentation tooling.
  • Includes lightweight readiness checks, manual execution, and path-filtered pull request validation.
  • Documents environment usage, validation commands, activation requirements, and integration-test limitations.
File Description
CONTRIBUTING.md Documents the Copilot environment, validation commands, and setup limitations.
.github/​workflows/​copilot-setup-steps.yml Configures dependency installation and readiness checks for Copilot sessions.

Review effort: Balanced

@rbell517
rbell517 enabled auto-merge (squash) October 29, 2026 19:06
@rbell517
rbell517 merged commit f4d2f4f into master Oct 29, 2026
14 checks passed
@rbell517
rbell517 deleted the agents/github-workflow-copilot-setup branch October 29, 2026 19:08
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