Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

feat: Add `sparse-checkout-aggregate` action

Aperta
#4 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
github-actions, shell
Ambito
ci-cd, devops

Direzione di ricerca

Inizia dal formato di sources.yml, dall’esempio di utilizzo di GitHub Actions e dai comandi sparse-checkout elencati. Definisci come devono comportarsi l’aggregazione completa e incrementale, il caching, l’accesso ai repository privati e gli output JSON, quindi verifica l’action rispetto agli esempi e alle forme degli output documentati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement new-action

Summary

Create a reusable GitHub Action that clones/updates multiple repositories using git sparse checkout based on a mapping file (sources.yml).

Use Case

Aggregate documentation from multiple repositories into a single build. Supports both full re-aggregation and incremental single-repo updates with caching.

Specification

Inputs
Input Required Default Description
sources_file Yes — Path to sources.yml mapping file
output_dir No .sources Directory for cloned repos
only No — Single repo to update (incremental mode)
token No ${{ github.token }} For private repos
Outputs
Output Description
sources JSON array of { key, repo, path, local_path, sha }
symlinks JSON array of { source, target } for symlink-map action
source_shas Hash of all repo SHAs for cache key
Example Output
// sources
[
  { "key": "ai", "repo": "arustydev/ai", "path": "docs/src", "local_path": ".sources/ai/docs/src", "sha": "abc123" },
  { "key": "just", "repo": "arustydev/just", "path": "docs/src", "local_path": ".sources/just/docs/src", "sha": "def456" }
]

// symlinks
[
  { "source": ".sources/ai/docs/src", "target": "books/ai" },
  { "source": ".sources/just/docs/src", "target": "books/just" }
]
Sources File Format (sources.yml)
books:
  ai:
    repo: arustydev/ai
    path: docs/src
    ref: main
    title: "AI Configuration"
  just:
    repo: arustydev/just
    path: docs/src
    ref: main
    title: "Justfile Library"
Example Usage
- uses: arustydev/gha/sparse-checkout-aggregate@v1
  id: aggregate
  with:
    sources_file: sources.yml
    only: ${{ github.event.client_payload.source_repo }}

Implementation Notes

Sparse Checkout Commands
# New clone
git clone --filter=blob:none --sparse --depth=1 \
    "https://github.com/$repo.git" ".sources/$key"
git -C ".sources/$key" sparse-checkout set "$path"

# Update existing
git -C ".sources/$key" fetch origin "$ref"
git -C ".sources/$key" checkout "origin/$ref" -- "$path"
Key Features
  • Use --filter=blob:none for minimal data transfer
  • Support incremental updates via only input
  • Output structured JSON for downstream actions
  • Calculate SHA hash for each repo for cache invalidation
  • Handle private repos via token input

Related

  • Part of docs aggregation workflow extraction
  • Outputs consumed by symlink-map action
  • Triggered by trigger-remote-workflow action
Lingua principale
Shell
Stelle
0
Fork
0
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aRustyDev/gh

Tutte le issue di aRustyDev/gh

Issue simili

Altre issue su Shell/Bash

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.