fix: resolve GitHub release asset API URL for private repo bundle downloads by lselvar · Pull Request #3136 · github/spec-kit

lselvar · 2026-06-23T21:36:31Z

Summary

Extends the private-repo GitHub release asset fix from fix: resolve GitHub release asset API URL for private repo extension downloads #2792 (extensions) and fix: resolve GitHub release asset API URL for private repo preset and workflow downloads #2855 (presets/workflows) to cover bundle manifest downloads
For private/SSO repos, browser release URLs (`https://github.com///releases/download//`) redirect to an HTML/SSO page instead of the asset, causing `bundle install` / `bundle info` to fail when the catalog's `download_url` points at such a URL
Applies `resolve_github_release_asset_api_url` (already in `_github_http.py`) in `_download_remote_manifest` before the HTTP download
Passes `github_provider_hosts()` to support GitHub Enterprise Server (GHES) private release URLs — matching the pattern already used by the extension, preset, and workflow fix paths

Fix — one download path is now covered

`_download_remote_manifest` (catalog-based bundle manifest download):

Resolves browser release URLs to REST API asset URLs before downloading the bundle manifest (YAML or ZIP)
Passes `github_hosts=github_provider_hosts()` so GHES browser release URLs resolve via `/api/v3` (parity with extensions/presets)
Direct REST API asset URLs (`api.github.com/repos/.../releases/assets/`) are passed through directly with `Accept: application/octet-stream`
ZIP payloads are detected via 4-byte magic signatures (`PK\x03\x04`, `PK\x05\x06`, `PK\x07\x08`) so direct REST API asset URLs pointing to ZIP bundles (which carry no file extension) are routed through the ZIP extraction path
URL extension detection uses `PurePosixPath(urlparse(url).path).suffix` to strip query strings/fragments before checking the `.zip` suffix
`require_https` is called on the resolved URL before issuing the download request (defence in depth)
`zipfile.BadZipFile` and `yaml.YAMLError` from post-download parsing are wrapped in `BundlerError` for clean user-facing error messages
Error messages include the original catalog URL and, when it differs, the resolved API URL so users know which entry to fix
Other URLs: existing behavior unchanged

Implementation

Uses the existing shared `resolve_github_release_asset_api_url(download_url, open_url_fn, timeout, github_hosts)` function from `_github_http.py` — the same utility used by the extension, preset, and workflow fixes. No new helpers needed.

Test plan

Run the bundler contract test suite:

UV_NATIVE_TLS=true SSL_CERT_FILE=/opt/homebrew/etc/openssl@3/cert.pem UV_DEFAULT_INDEX=https://pypi.org/simple PYTHONPATH=src uv run --extra test pytest tests/contract/test_bundle_cli.py -v

Expected: 30 passed (includes 6 new tests)

Run full bundler test suite:

UV_NATIVE_TLS=true SSL_CERT_FILE=/opt/homebrew/etc/openssl@3/cert.pem UV_DEFAULT_INDEX=https://pypi.org/simple PYTHONPATH=src uv run --extra test pytest tests/contract/ tests/unit/ tests/integration/ tests/test_github_http.py

Expected: all passing

Verify `specify bundle install ` works when the catalog's `download_url` points at a GitHub release asset on a private repo
Verify `specify bundle info ` works for the same case

AI disclosure: This PR was developed with Claude Code assistance.

🤖 Generated with Claude Code

…nloads For private/SSO-protected GitHub repos, browser release download URLs (https://github.com/<owner>/<repo>/releases/download/<tag>/<asset>) redirect to an HTML/SSO page instead of delivering the asset, causing bundle manifest downloads to fail. Extends the pattern from github#2855 (presets/workflows) to cover the bundle manifest download path in _download_remote_manifest: - Resolves browser release URLs to GitHub REST API asset URLs via resolve_github_release_asset_api_url before downloading - Direct REST API asset URLs (api.github.com/repos/.../releases/assets/<id>) are passed through directly - Both cases use Accept: application/octet-stream so the API returns the binary payload rather than JSON metadata - The original catalog URL is used to determine artifact format (.zip vs YAML) since the resolved API URL does not carry the file extension Adds two CLI-level contract tests: - bundle info resolves browser release URL via GitHub tags API - bundle info passes direct API asset URL through with octet-stream Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Pull request overview

This PR extends the existing “private GitHub release asset download URL” fix to the bundle manifest download path, ensuring bundle info / bundle install can successfully download manifests from private/SSO-protected GitHub release assets by resolving browser release URLs to GitHub REST asset URLs and downloading them with Accept: application/octet-stream.

Changes:

Apply resolve_github_release_asset_api_url() in _download_remote_manifest() to translate GitHub browser release download URLs into REST asset URLs prior to downloading.
Send Accept: application/octet-stream when downloading via GitHub REST asset URLs to retrieve the binary payload instead of JSON metadata.
Add contract tests validating browser-URL resolution and direct REST asset URL passthrough for bundle info.

Show a summary per file

File	Description
`src/specify_cli/commands/bundle/__init__.py`	Resolve GitHub release asset URLs before manifest download; download assets via REST with octet-stream header.
`tests/contract/test_bundle_cli.py`	Add contract coverage for browser release URL resolution and direct REST asset URL behavior for bundle manifest downloads.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Files reviewed: 2/2 changed files
Comments generated: 2

mnriem

Please address Copilot feedback

Address Copilot review feedback on PR github#3136: 1. Detect ZIP payloads by magic bytes (PK\x03\x04) in addition to the '.zip' URL suffix so that direct GitHub REST asset URLs — which carry no file extension — are correctly routed through the ZIP extraction path when the asset is a ZIP bundle artifact. 2. Add two new contract tests: - test_bundle_info_resolves_github_browser_release_url_zip: exercises the '.zip' browser release URL path end-to-end, verifying the tags API lookup fires, octet-stream header is used, and bundle.yml is successfully extracted from the ZIP payload. - test_bundle_info_api_asset_url_zip_detected_by_magic_bytes: verifies that a direct REST asset URL returning ZIP bytes is detected by magic and parsed correctly without a tags API call. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Review details

Files reviewed: 2/2 changed files
Comments generated: 3
Review effort level: Low

mnriem · 2026-06-26T17:35:11Z

Please address Copilot feedback ;)

Address second-round Copilot review feedback on PR github#3136: - Error message: when the download fails, report the original catalog download_url so the user knows which entry to fix; include the resolved REST API URL when it differs for easier debugging. - ZIP detection: broaden the magic-bytes check from PK\x03\x04 to raw[:2] == b"PK", covering all valid ZIP variants (local-file header PK\x03\x04, empty-archive PK\x05\x06, spanned/split PK\x07\x08). - Tests: remove the unused tmp_path parameter from test_bundle_info_resolves_github_browser_release_url_zip. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Review details

Files reviewed: 2/2 changed files
Comments generated: 1
Review effort level: Low

mnriem · 2026-06-26T21:48:27Z

Please address Copilot feedback. Almost there!

Address Copilot feedback: raw[:2] == b"PK" is too broad and could misclassify any payload starting with ASCII "PK" as a ZIP, producing a confusing "not a valid bundle" error. Use the three specific 4-byte ZIP magic signatures instead: PK\x03\x04 — local file header (standard ZIP) PK\x05\x06 — end-of-central-directory (empty archive) PK\x07\x08 — data descriptor / spanning marker Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Review details

Files reviewed: 2/2 changed files
Comments generated: 1
Review effort level: Low

mnriem · 2026-06-29T14:41:51Z

Please address Copilot feedback

- Promote _ZIP_SIGNATURES to module-level constant (was redefined per call) - Use PurePosixPath for URL path suffix extraction so query strings and fragments are ignored and URL paths are treated as POSIX on all OSes - Move yaml/BundleManifest imports to function top to flatten the previously nested try/except into a single handler with explicit except _yaml.YAMLError and except Exception clauses - Re-add None guard on _local_manifest_source return: the function is typed Optional[BundleManifest] and without the guard a None return propagates silently to callers that degrade gracefully rather than raising an actionable error; comment explains it is defensive not dead - Assert exact resolved asset URL in browser-URL download tests, not just the Accept header, so a regression where download uses the original URL instead of the resolved one would be caught - Add resolution-failure test: when tags API finds no matching asset the code falls back to the original URL and exits non-zero with Error: Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

…ivate-github-release-bundle-downloads

…wnloads Extends the GHES support pattern from extensions and presets (github#2855, github#3157) to the bundle manifest download path: resolve_github_release_asset_api_url now receives github_hosts=github_provider_hosts() so browser release URLs from GitHub Enterprise Server instances are resolved via /api/v3 rather than falling back to the unauthenticated download path. Also adds a contract test covering the GHES resolution path for _download_remote_manifest (analogous to the existing github.com tests). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Fixes private/SSO-protected GitHub release bundle downloads by resolving browser release URLs to GitHub REST API asset URLs, with full GHES support.

Copilot

Review details

Files reviewed: 2/2 changed files
Comments generated: 1
Review effort level: Low

mnriem · 2026-07-01T17:27:32Z

Please address Copilot feedback

The dict was defined but never consumed — the test drives GHES host recognition entirely through the github_provider_hosts() patch. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot

Review details

Files reviewed: 2/2 changed files
Comments generated: 3
Review effort level: Low

Thread the catalog URL (and resolved API URL when it differs) into the YAML parse, generic parse, and ZIP-extraction error paths of _download_remote_manifest so failures point at the offending source instead of an opaque temp path. Addresses PR review feedback. Assisted-by: GitHub Copilot (model: Claude Opus 4.8, autonomous) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

mnriem · 2026-07-01T21:21:19Z

Addressed all three review comments in b41a2fe: the YAML parse error, the generic parse error, and the ZIP-extraction path in _download_remote_manifest now include the source URL context (the original catalog URL, plus the resolved API URL when it differs) via a shared _source_desc. The ZIP branch also wraps the _local_manifest_source call so BadZipFile / missing bundle.yml failures reference the source URL instead of the temp path. All 30 test_bundle_cli.py contract tests pass.

Posted by GitHub Copilot (model: Claude Opus 4.8) on behalf of @mnriem.

Copilot

Review details

Files reviewed: 2/2 changed files
Comments generated: 0 new
Review effort level: Low

mnriem · 2026-07-01T21:30:57Z

Thank you! Hope you didn't mind me finishing it out

lselvar requested a review from mnriem as a code owner June 23, 2026 21:36

mnriem requested a review from Copilot June 24, 2026 12:43

Copilot started reviewing on behalf of mnriem June 24, 2026 12:44 View session

Copilot AI reviewed Jun 24, 2026

View reviewed changes

Comment thread tests/contract/test_bundle_cli.py

Comment thread src/specify_cli/commands/bundle/__init__.py Outdated

mnriem requested changes Jun 24, 2026

View reviewed changes

mnriem requested a review from Copilot June 26, 2026 16:28

Copilot started reviewing on behalf of mnriem June 26, 2026 16:28 View session

Copilot AI reviewed Jun 26, 2026

View reviewed changes

Comment thread src/specify_cli/commands/bundle/__init__.py Outdated

Comment thread src/specify_cli/commands/bundle/__init__.py Outdated

Comment thread tests/contract/test_bundle_cli.py Outdated

mnriem requested a review from Copilot June 26, 2026 19:11

Copilot started reviewing on behalf of mnriem June 26, 2026 19:12 View session

Copilot AI reviewed Jun 26, 2026

View reviewed changes

Comment thread src/specify_cli/commands/bundle/__init__.py Outdated

mnriem requested a review from Copilot June 29, 2026 12:31

Copilot started reviewing on behalf of mnriem June 29, 2026 12:31 View session

Copilot AI reviewed Jun 29, 2026

View reviewed changes

Comment thread tests/contract/test_bundle_cli.py

lselvar and others added 4 commits June 30, 2026 21:16

Merge branch 'main' of https://github.com/github/spec-kit into fix/pr…

7f1b20b

…ivate-github-release-bundle-downloads

Merge branch 'fix/private-github-release-bundle-downloads'

1b2db81

Fixes private/SSO-protected GitHub release bundle downloads by resolving browser release URLs to GitHub REST API asset URLs, with full GHES support.

mnriem requested a review from Copilot July 1, 2026 16:48

Copilot started reviewing on behalf of mnriem July 1, 2026 16:49 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

Comment thread tests/contract/test_bundle_cli.py Outdated

test(bundle): remove unused ghes_entry variable from GHES contract test

2aa9571

The dict was defined but never consumed — the test drives GHES host recognition entirely through the github_provider_hosts() patch. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

mnriem requested a review from Copilot July 1, 2026 21:02

Copilot started reviewing on behalf of mnriem July 1, 2026 21:03 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

Comment thread src/specify_cli/commands/bundle/__init__.py

Comment thread src/specify_cli/commands/bundle/__init__.py

Comment thread src/specify_cli/commands/bundle/__init__.py Outdated

mnriem requested a review from Copilot July 1, 2026 21:23

Copilot started reviewing on behalf of mnriem July 1, 2026 21:23 View session

Copilot AI reviewed Jul 1, 2026

View reviewed changes

mnriem self-requested a review July 1, 2026 21:29

mnriem approved these changes Jul 1, 2026

View reviewed changes

mnriem merged commit 3b30e40 into github:main Jul 1, 2026
12 checks passed

Uh oh!

Conversation

lselvar commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Fix — one download path is now covered

Implementation

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Copilot's findings

Uh oh!

Uh oh!

Uh oh!

mnriem left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mnriem commented Jun 26, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

Uh oh!

mnriem commented Jun 26, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

Uh oh!

mnriem commented Jun 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

Uh oh!

mnriem commented Jul 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mnriem commented Jul 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Review details

Uh oh!

Uh oh!

mnriem commented Jul 1, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lselvar commented Jun 23, 2026 •

edited

Loading