Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

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

Ouverte
#8,753 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
40/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
Active
Stack technique
github-actions
Domaine
ci-cd

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

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.

Langage dominant
OCaml
Étoiles
7.5k
Forks
484
Merge moyen
19 h 20 min
PR mergées (30 j)
96

Préparer son environnement

Ouvrir dans Codespaces

Lance le conteneur de développement du projet dans votre navigateur, avec votre propre compte GitHub.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de rescript-lang/rescript

Toutes les issues de rescript-lang/rescript

Issues similaires

Plus d'issues DevOps

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.