Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Route v13 API-docs CI and publication to website branch v13

Open
  • Is something wrong?
#8,753 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
40/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
github-actions
Domain
ci-cd

Research direction

Start with the api-docs job in .github/workflows/ci.yml and the publish job in .github/workflows/publish.yml, and find where each checks out the website's default branch. Add a step that derives the compiler major from the version, including prereleases, and maps 12 to master and 13 to v13. Then confirm that the artifact lands in data/api and that publishing commits to the chosen branch. Done means both workflows select the branch correctly for stable and alpha versions, and the v12 path is unchanged. Website #1433 must land first.

Written by the indexing model from the issue text.

Description

Compiler master generates v13 API snapshots, but both the API-docs CI check and release publication check out the website's default branch. Website master selects v12 data, so building it with a new v13 artifact does not validate v13 API pages, and publishing there does not update the website's v13 branch.

Target branch: compiler master (v13). This changes workflow routing, not compiler language behavior.

  • In .github/workflows/ci.yml, make the api-docs job check out the matching website branch before downloading and building the generated artifact.
  • In .github/workflows/publish.yml, use the same branch mapping for the website checkout, build, and API-data commit/push.
  • Map compiler major 12 to website master, and compiler major 13 to website v13. Derive the major from the compiler/release version, including prereleases.
  • Download artifacts into repository-root data/api, and require a successful build of the matching website before publishing its API-data changes.

Acceptance: v13 CI builds website branch v13 with the incoming v13 snapshot; v13 release publication commits that snapshot to v13 and triggers the appropriate website deployment. Verify branch selection for stable and alpha versions, and preserve the v12 maintenance publication path to website master.

Prerequisite: website #1433 must land first so the v13 website consumes and validates the published data. Confirm the v13 website deployment trigger as part of the coordinated rollout.

Related: website #1391 and website PR #1432.

Dominant language
OCaml
Stars
7.5k
Forks
484
Avg merge
19h 46m
Merged PRs (30d)
81

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from rescript-lang/rescript

All issues in rescript-lang/rescript

Similar issues

More DevOps issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.