Repository navigation
Route API docs to the website branch matching the compiler major - #8945
Conversation
Why:
Following the website default branch lets v13 compiler prereleases
update stable v12 API docs. The target must follow the compiler
package version through website promotions and maintenance branch cuts.
Select v<major> for API checks and publication, push to that branch
explicitly, and cover maintenance branches in CI. Test release promotion
and branch cuts without changing the API documentation destination.
Signed-off-by: Florian Hammerschmidt <florianh89@gmail.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #8945 +/- ##
==========================================
+ Coverage 81.27% 81.29% +0.01%
==========================================
Files 456 456
Lines 63828 63836 +8
==========================================
+ Hits 51875 51893 +18
+ Misses 11953 11943 -10 🚀 New features to boost your workflow:
|
Why:
The API routing CLI tests exposed an entry-point check that compares
a file URL to a Windows path prefixed with file://. It skips main on
Windows and exits successfully without writing the workflow outputs.
Compare resolved filesystem paths, using the same check as changelog.js.
The existing CLI output tests cover the failure on Windows CI.
Signed-off-by: Florian Hammerschmidt <florianh89@gmail.com>
Changelog
Semantic Diff4 commits · Full page Route API docs to the website branch matching the compiler major0c5afa5 · fhammerschmidt · Oct 21, 2026, 16:34 UTC
Select v<major> for API checks and publication, push to that branch explicitly, and cover maintenance branches in CI. Test release promotion and branch cuts without changing the API documentation destination. Run release planning from Windows script paths40a05a7 · fhammerschmidt · Oct 21, 2026, 16:51 UTC
Compare resolved filesystem paths, using the same check as changelog.js. The existing CLI output tests cover the failure on Windows CI. ✨ Remove the deleted release branch from push CI849306e · fhammerschmidt + Christoph Knittel · Oct 22, 2026, 15:43 UTC · new The review noted that 11.0_release no longer exists. Keep CI on master and maintenance branches for push events. ✨ Remove the deleted release branch from pull request CIe533ad4 · fhammerschmidt + Christoph Knittel · Oct 22, 2026, 15:43 UTC · new The review noted that 11.0_release no longer exists. Keep CI on master and maintenance branches for pull request events. |
rescript
@rescript/belt
@rescript/darwin-arm64
@rescript/linux-arm64
@rescript/linux-x64
@rescript/runtime
@rescript/win32-x64
commit: |
|
Developer playground preview: https://rescript-lang.github.io/rescript/dev-playground/?version=pr-8945 |
|
@codex review |
|
Codex Review: Didn't find any major issues. 🎉 Reviewed commit: ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
The review noted that 11.0_release no longer exists. Keep CI on master and maintenance branches for push events. Co-authored-by: Christoph Knittel <ck@cca.io> Signed-off-by: Florian Hammerschmidt <florianh89@gmail.com>
The review noted that 11.0_release no longer exists. Keep CI on master and maintenance branches for pull request events. Co-authored-by: Christoph Knittel <ck@cca.io> Signed-off-by: Florian Hammerschmidt <florianh89@gmail.com>
Bring the API documentation routing PR up to date with master and its fix for matching the Semantic Diff workflow to the renderer. Preserve the CI branch filters applied through the GitHub web UI. Signed-off-by: Florian Hammerschmidt <florianh89@gmail.com>
9b60d92 to
f3eb117
Compare
Keep v12 API docs on website branch v12 The maintenance workflow follows the website default branch. Pin its checkout and push to v12 so future website promotion keeps v12 maintenance snapshots on their own documentation branch. Follow up on #8945 and #8753. Signed-off-by: Florian Hammerschmidt <florianh89@gmail.com>
API documentation checks and publication currently follow the website’s default branch. With stable docs now on
v12, compilermaster(v13) can otherwise publish prerelease APIs into stable documentation.Derive the target as
v${major}from the compiler package version and use it for CI and release checkout/push. This keeps API routing independent of website promotion and compiler maintenance branch cuts. The shared playground refresh hook continues to target the default website.Related to #8753.
Next steps
maintenance/12.xAPI publication to docsv12.v13with its matching compiler/example formatting and deployment routing; keepv12as the public default until release.v13to default, align Cloudflare’s production branch and playground hook, and deploy. Cutmaintenance/13.xbefore compilermasteradvances to the next major.