Skip to content

Commit ea7f160

Browse files
authored
Merge pull request #49 from cvmfs-contrib/docs/copilot-instructions
docs: Add Copilot instructions
2 parents 00a1279 + afaf162 commit ea7f160

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

COPILOT_INSTRUCTION.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# GitHub Copilot Instruction
2+
3+
This repository is used globally by a large userbase and must support two major integration approaches:
4+
5+
1. **GitHub Actions (github-actions-cvmfs):**
6+
- The repository is included in CI/CD workflows by other projects using the composite GitHub Action defined in `action.yml`.
7+
- The action must work reliably on both Linux and macOS runners, using the modular scripts (`setup-cvmfs-linux.sh`, `setup-cvmfs-macos.sh`).
8+
- All configuration options and environment variables documented in `action.yml` must remain supported.
9+
10+
2. **Devcontainer Feature:**
11+
- The repository provides a devcontainer feature (`src/cvmfs`) for use in VS Code and other devcontainer environments.
12+
- The feature must install and configure CVMFS correctly in Ubuntu-based containers, using the modular setup.
13+
- The feature must remain compatible with the published OCI artifact and local development.
14+
15+
**Critical Guidance:**
16+
- Any changes must preserve full functionality for both approaches.
17+
- Avoid regressions: breaking either the GitHub Action or the devcontainer feature will impact many users and organizations worldwide.
18+
- Test changes in both contexts before merging or releasing.
19+
- Document any changes to configuration, environment variables, or usage in the README and relevant documentation files.
20+
21+
> **Copilot:** When assisting with this repository, always ensure that both the GitHub Action and devcontainer feature remain fully functional and compatible. Prioritize stability and backward compatibility for the global userbase.

0 commit comments

Comments
 (0)