Repository navigation
INTER-2472: Update schema URL and harden sync script - #207
Conversation
Update the OpenAPI schema URL for the repository rename to `openapi`. Use an `env bash` shebang so the script picks up bash from PATH rather than whatever sits at /bin/bash. Resolve paths relative to the repository root, so the script no longer writes into whatever directory it is invoked from. Collect the curl flags into `CURL_OPTS`, gated on `TRACE` and `ACTIONS_STEP_DEBUG` so runs can be made verbose, and harden them: retry transient failures, refuse redirects that leave https, and bound connect and transfer time so a stalled download cannot hang CI or a local run. Rename `examplesList` to `examples` and log the full URL being fetched rather than just the example path, so it is clear which base URL a run actually used. Log the schema download, which was previously silent. Mark the script executable. `contributing.md` documents `./sync.sh`, which failed with a permission error because the file was not executable. Related-Task: INTER-2472
|
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Silent curl failures need actionable diagnostics, and the prerequisite upstream PR remains unmerged.
Get a fresh assessment by requesting another Copilot review.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Updates sync.sh for the planned OpenAPI repository rename and improves download reliability.
Changes:
- Uses the renamed GitHub Pages schema URL.
- Resolves paths from the repository root and marks the script executable.
- Adds retries, timeouts, HTTPS redirect restrictions, and clearer logging.
| File | Description |
|---|---|
sync.sh |
Updates schema synchronization URL, paths, curl options, and logging. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
pnpm exec changesetto create a changeset. |
erayaydin
changed the title
GitHub redirects repository URLs after a rename but explicitly not project GitHub Pages URLs, so
sync.shwill start failing with a 404. This PR changes the default OpenAPI schema URL.Alongside the URL change, use
env bashshebang, so the script picks up bash from the correct environment. Resolve paths relative to the repository root, so the script no longer writes into whatever directory it is invoked from. Collect thecurlflags intoCURL_OPTS, gated onTRACEandACTIONS_STEP_DEBUGso runs can be made verbose, and harden them with retry transient failures, refuse redirects that leave https and bound connect and transfer time so a stalled download cannot hang CI or local. RenameexamplesListtoexamples, log the full URL being fetched rather than just the example path, so it is clear which base URL a run actually used, and log the schema download, which was previously silent.Mark
sync.shexecutable.contributing.mddocuments running./sync.sh, but the file was not executable, so that command failed with a permission error. This is pre-existing and unrelated to the rename.