Files
awesome-copilot/eng
Aaron Powell 8ae5a99109 Enforce external plugin ref/sha consistency (#2463)
* Enforce external plugin ref/sha consistency

Extract shared ref/sha normalization and consistency checks into eng/lib and reuse them in intake plus quality gate flows.

Add a dedicated ref/sha consistency quality gate surfaced in PR/intake summaries, and add targeted tests for matching and mismatched refs.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 6afe21ad-eafa-4c90-a1f2-053dedac7625

* Address review: tree/blob ref errors and PR workflow ref/sha column

- resolveCommitShaAtReadRef: classify rev-parse failure as 'fail'
  instead of 'infra_error' because a successfully-fetched ref that
  doesn't dereference to a commit is a submitter problem, not infra.
- validateRemoteRepository (intake): treat HTTP 422 from the commit
  endpoint as a submitter error; all other non-404 errors remain
  transient warnings requiring maintainer re-run.
- external-plugin-pr-quality-gates.yml: add ref/sha consistency
  column to the per-plugin quality table and failure details block.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 6afe21ad-eafa-4c90-a1f2-053dedac7625

---------

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 6afe21ad-eafa-4c90-a1f2-053dedac7625
2026-07-29 15:28:13 +10:00
..
2025-12-18 09:53:16 -08:00

Contributor Reporting (Maintainers) 🚧

This directory contains build scripts and utilities for maintaining the repository.

Build Scripts

update-readme.mjs

Generates the main README.md and documentation files from the repository content (agents, prompts, instructions, skills, hooks, collections).

generate-marketplace.mjs

Automatically generates .github/plugin/marketplace.json from all plugin directories in the plugins/ folder. This file is used by the GitHub Copilot CLI to discover and install plugins from this repository.

How it works:

  • Scans all directories in plugins/
  • Reads each plugin's .github/plugin/plugin.json for metadata
  • Generates a consolidated marketplace.json with all available plugins
  • Runs automatically as part of npm run build

To run manually:

npm run plugin:generate-marketplace

generate-website-data.mjs

Generates JSON data files for the website from repository content.

Contributor Tools

  • contributor-report.mjs — generates a markdown report of merged PRs for missing contributors (includes shared helpers).
  • add-missing-contributors.mjs — on-demand maintainer script to automatically add missing contributors to .all-contributorsrc (infers contribution types from merged PR files, then runs the all-contributors CLI).

Key notes for maintainers

  • Reports are generated on-demand and output to reports/contributor-report.md for human review.
  • The report output is intentionally minimal: a single list of affected PRs and one command to add missing contributor(s).
  • This repository requires full git history for accurate analysis. In CI, set fetch-depth: 0.
  • Link: all-contributors CLI documentation

On-demand scripts (not CI)

These are maintainer utilities. They are intentionally on-demand only (but could be wired into CI later).

add-missing-contributors.mjs

  • Purpose: detect missing contributors, infer contribution types from their merged PR files, and run npx all-contributors add ... to update .all-contributorsrc.
  • Requirements:
    • GitHub CLI (gh) available (used to query merged PRs).
    • .all-contributorsrc exists.
    • Auth token set to avoid the anonymous GitHub rate limits:
      • Set GITHUB_TOKEN (preferred), or GH_TOKEN for the gh CLI.
      • If you use PRIVATE_TOKEN locally, contributor-report.mjs will map it to GITHUB_TOKEN.

Graceful shutdown

  • contributor-report.mjs calls setupGracefulShutdown('script-name') from eng/utils/graceful-shutdown.mjs early in the file to attach signal/exception handlers.

Testing & maintenance

  • Helper functions have small, deterministic behavior and include JSDoc comments.
  • The getMissingContributors function in contributor-report.mjs is the single source of truth for detecting missing contributors from all-contributors check output.