ably
Add copilot setup workflow and instructions
Added GitHub Copilot agent support for the ably-cocoa repository by creating two new files:
Files Added
.github/workflows/copilot-setup-steps.yml
A GitHub Actions workflow that sets up the complete development environment for Copilot agents, including:
- Xcode 16.3 selection and environment configuration
- Simulator reset for clean testing state
- Dependencies installation (xcbeautify, carthage, submodules, ruby gems)
- Carthage dependencies update for all platforms
- Setup verification with version checks
.github/copilot-instructions.md
Comprehensive development instructions for Copilot agents containing:
- Prerequisites and initial setup steps (
make update) - All key development commands for building and testing across iOS/tvOS/macOS platforms
- Dependency management commands for Carthage updates
- Fastlane commands with required environment variables (
ABLY_ENV=sandbox) - Project structure overview and common troubleshooting tips
Implementation Details
The workflow follows the same structure and steps as the existing integration-test.yaml workflow, ensuring consistency with the current CI setup. All commands and Make targets have been verified against the actual Makefile and fastlane/Fastfile to ensure accuracy.
This enables GitHub Copilot agents to automatically set up the development environment and understand the available build/test commands when working on tasks in this repository.
Fixes #2061.
💡 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.
@owenpearson Thanks for sending me some feedback. Unfortunately, I hit an error while trying to use the custom Copilot setup steps configured for this repository. The error I am seeing is:
No `copilot-setup-steps` job found in your Copilot setup steps workflow file. Please ensure you have a single job named `copilot-setup-steps`. For more details, see https://gh.io/copilot/actions-setup-steps.
Once you or someone with the necessary access fixes the problem, please let me know in a comment and I'll try again. Thanks!
@owenpearson Thanks for sending me some feedback. Unfortunately, I hit an error while trying to use the custom Copilot setup steps configured for this repository. The error I am seeing is:
No `copilot-setup-steps` job found in your Copilot setup steps workflow file. Please ensure you have a single job named `copilot-setup-steps`. For more details, see https://gh.io/copilot/actions-setup-steps.
Once you or someone with the necessary access fixes the problem, please let me know in a comment and I'll try again. Thanks!
@copilot can you try running some simple commands to check that changing the job name to copilot-setup-steps actually worked?
