Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Extract the fat inline bash steps from upstream-release-docs.yml into scripts/

Chiusa
  • Qualcosa non va?
#1,112 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
bash, github-actions, javascript
Ambito
ci-cd, devops, tooling

Direzione di ricerca

Leggi .github/workflows/upstream-release-docs.yml, il passaggio Augment PR body e i file esistenti in scripts/upstream-release/. Usa l'ambiente di un'esecuzione reale precedente per confrontare l'output dello script estratto con il PR body effettivo di quell'esecuzione; il lavoro è completo quando il comportamento è preservato e lo script è coperto dalla configurazione esistente di formatting e linting.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement github_actions needs-triage

.github/workflows/upstream-release-docs.yml is 1667 lines across 41 steps, including 960 lines of inline bash. The size is concentrated in four steps:

Step Inline bash lines
Augment PR body (marker-delimited section) 313
Assign reviewers and prepare contributor mentions 121
Resolve release owner and contributors 99
Capture skill signal files 74
remaining 37 steps 353 (avg 9)

Two reasons to extract the big ones:

  • Nothing lints the inline bash. There is no shellcheck or actionlint in CI, so checking a change today means hand-extracting steps[].run from the YAML, stubbing ${{ }}, and piping it to shellcheck.
  • scripts/upstream-release/ already holds five .mjs files and this workflow already invokes one, so a script there inherits Prettier and ESLint from existing CI with no new tooling.

Augment PR body is the best first candidate: its only I/O is roughly 25 env vars in and one gh pr edit --body-file out, and the PR body is the artifact reviewers actually read.

Scope

In:

  • Augment PR body to scripts/upstream-release/render-pr-body.mjs
  • Assign reviewers and Resolve release owner and contributors as separate follow-ups if the first goes cleanly

Out:

  • The two Claude step prompts (88 lines). Their content is almost entirely interpolated run context, and the durable instructions already live in the upstream-release-docs skill.
  • Capture skill signal files, mostly file reads and GITHUB_OUTPUT heredocs.
  • The 37 short steps, which belong inline.

Sequencing

After #1111 has run live on two or three release PRs. That change is unvalidated, and stacking a refactor on it means a live failure has two candidate causes instead of one.

#1111 and this refactor touch the same steps, so if #1111 needs iteration, extract Augment PR body first (#1111 only added two table rows and two sections to it) and leave the reviewer steps until after validation.

Verification

Behavior-preserving: render the extracted script against the env of a real past run and diff the output against that run's actual PR body.

Lingua principale
TypeScript
Stelle
4
Fork
4
Merge medio
1g 1h
PR unite (30g)
58

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stacklok/docs-website

Tutte le issue di stacklok/docs-website

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.