Skip to content

Add comprehensive GitHub Copilot instructions for ORAS CLI development #1820

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add comprehensive GitHub Copilot instructions for ORAS CLI development #1820

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# GitHub Copilot Instructions

## Project
ORAS (OCI Registry As Storage) - Go CLI tool for OCI artifact management using Cobra framework.

## Build & Test
```bash
make # Build for current platform
make test # Unit tests with coverage
make teste2e # E2E tests
make lint # Run linter
```

## Repository Structure
```
cmd/oras/ # CLI entry and commands
├── main.go # Minimal entry point
└── root/ # Root command and subcommands
├── *.go # Core commands (pull, push, login, tag, etc.)
├── blob/ # Blob operations (push, fetch, delete)
├── manifest/ # Manifest operations (push, fetch, delete)
└── repo/ # Repository operations (ls, tags)

internal/ # Internal packages (non-importable)
├── credential/ # Registry authentication
├── contentutil/ # Artifact content handling
├── progress/ # Progress display
├── tree/ # Artifact tree printing
├── cache/ # Caching layer
├── graph/ # Dependency graphs
└── io/ # I/O utilities

test/e2e/ # End-to-end tests
docs/ # Documentation
vendor/ # Vendored dependencies
```

## Architecture
- **Entry**: `cmd/oras/main.go` → `cmd/oras/root/cmd.go`
- **Commands**: `cmd/oras/root/*.go` and `cmd/oras/root/{blob,manifest,repo}/`
- **Internal**: Business logic in `internal/` (credential, contentutil, progress, tree, trace)
- **Core lib**: `oras.land/oras-go/v2`

## Patterns
- Command pattern with `*cobra.Command`
- Internal packages only (no external imports)
- Dependency injection over globals
- Tests alongside source (`*_test.go`)
- E2E tests in `test/e2e/`

## Key Files
- `Makefile`: Build orchestration
- `.goreleaser.yml`: Release configuration
- Version injection via ldflags
Loading