Skip to content

feat: add GitHub Packages registry to benchmarks#71

Merged
darcyclarke merged 1 commit intovltpkg:mainfrom
vltbaudbot:feat/github-registry
Mar 11, 2026
Merged

feat: add GitHub Packages registry to benchmarks#71
darcyclarke merged 1 commit intovltpkg:mainfrom
vltbaudbot:feat/github-registry

Conversation

@vltbaudbot
Copy link
Contributor

Add GitHub Packages (npm.pkg.github.com) as a fifth registry in the benchmark suite alongside npm, vlt, AWS CodeArtifact, and Cloudsmith.

Backend

  • Add GitHub registry config to scripts/registry/common.sh
    • GH_REGISTRY env var provides the URL (without protocol, e.g. //npm.pkg.github.com/...)
    • GH_AUTH_TOKEN env var provides the auth token
    • Registry URL is prefixed with https: for npm config
    • Auth token is configured using the URL as-is for the .npmrc key
  • Add GitHub to hyperfine commands in registry-clean.sh and registry-lockfile.sh
  • Add GitHub to REGISTRY_COLORS in generate-chart.js (#6336b8)
  • Add GH_REGISTRY and GH_AUTH_TOKEN secrets to CI workflow
  • Update bench CLI: AVAILABLE_REGISTRIES, usage text, examples

Frontend

  • Add 'github' to PackageManager union type and all data interfaces (PackageManagerData, PackageManagerVersions, PackageCountData)
  • Add GitHub icon component (Octicons mark-github logo from Wikimedia)
  • GitHub icon renders white in dark mode (same treatment as vlt — black logo needs inversion)
  • Add to icon map: github → Github
  • Add display names: 'GitHub' (general) / 'npm.pkg.github.com' (registry variation)
  • Add to history data package managers list

Required secrets

The following secrets need to be configured in the repository:

  • GH_REGISTRY — GitHub Packages npm registry URL (without protocol prefix)
  • GH_AUTH_TOKEN — GitHub Packages auth token

Add GitHub Packages (npm.pkg.github.com) as a fifth registry in the
benchmark suite alongside npm, vlt, AWS CodeArtifact, and Cloudsmith.

Backend:
- Add GitHub registry config to scripts/registry/common.sh
  - GH_REGISTRY env var provides the URL (without protocol)
  - GH_AUTH_TOKEN env var provides the auth token
  - Registry URL is prefixed with 'https:' for npm config
- Add GitHub to hyperfine commands in registry-clean.sh and
  registry-lockfile.sh
- Add GitHub to REGISTRY_COLORS in generate-chart.js (#6336b8)
- Add GH_REGISTRY and GH_AUTH_TOKEN secrets to CI workflow
- Update bench CLI: AVAILABLE_REGISTRIES, usage text, examples

Frontend:
- Add 'github' to PackageManager union type and all data interfaces
- Add GitHub icon component (Octicons mark-github logo)
- GitHub icon renders white in dark mode (same pattern as vlt)
- Add GitHub to icon map, display names ('GitHub' / 'npm.pkg.github.com')
- Add to history data package managers list
@darcyclarke darcyclarke merged commit 20dd421 into vltpkg:main Mar 11, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants