Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

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

Aberta
  • Algo errado?
#8,753 0 comentários 0 reações 0 responsáveis Ver no GitHub

Mantenedores costumam responder em até 1 dia

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
3/5
Tempo estimado
1-2 dias
Facilidade para iniciantes
40/100
Tipo de issue
Bug
Clareza
Razoavelmente clara
Status de atividade
Ativa
Stack de tecnologia
github-actions
Domínio
ci-cd

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
ReScript
Estrelas
7.5k
Forks
483
Merge médio
1d 4h
PRs com merge (30d)
127

Preparar o ambiente

Abrir no Codespaces

Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de rescript-lang/rescript

Todas as issues de rescript-lang/rescript

Issues semelhantes

Mais issues de DevOps

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.