Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

feat: Add `sparse-checkout-aggregate` action

Open
#4 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, shell
Domain
ci-cd, devops

Research direction

Start with the sources.yml format, the example GitHub Actions usage, and the listed sparse-checkout commands. Define how full and incremental aggregation, caching, private-repository access, and the JSON outputs should behave, then verify the action against the documented examples and output shapes.

Written by the indexing model from the issue text.

Description

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
Dominant language
Shell
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from aRustyDev/gh

All issues in aRustyDev/gh

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.