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

[Docs]: Remind release engineers to update shared docs after each release

Aperta Adatta ai principianti
  • Qualcosa non va?
#843 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@hln33 ci sta già lavorando.

Dal 29/10/2026.

  • #845 di @hln33 — aperta

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
88/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
java
Ambito
documentation

Direzione di ricerca

Apri RELEASE.md e leggi la sezione 4, «Update the shared documentation.» Amplia la checklist in modo che includa ogni pacchetto rilasciato, le API modificate, il comportamento, gli esempi, le versioni, la compatibilità e le indicazioni per la migrazione, con un link al repository condiviso della documentazione. Conferma che al Release Engineer venga chiesto di aprire o aggiornare il PR della documentazione, eseguire i controlli applicabili, seguirlo durante la revisione e il merge oppure annotare che non erano necessarie modifiche alla documentazione.

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

Descrizione

documentation
Requested change

Update RELEASE.md to remind release engineers to review and update aws/aws-durable-execution-docs after each new Java release. This is a documentation-only change to the human release process.

The existing "Update the shared documentation" section in RELEASE.md reminds engineers to update literal dependency versions. Expand that section to cover released APIs, behavior, and examples as well.

Why

Docs PR #300 was needed to catch references and examples up with released Java, TypeScript, and Python functionality, including SDK 3 plugin factories, serialization, telemetry, and testing APIs. A reminder in the release instructions should help prevent this drift.

Release checklist guidance
  • Expand section 4, "Update the shared documentation," with an explicit checklist for the release engineer after publication is verified.
  • Link directly to the shared docs repository and remind the engineer to review the changes in every package released, including testing and plugin packages when applicable.
  • Update affected API references, guides, and examples/java/ snippets, along with dependency versions, compatibility guidance, and migration instructions as needed. Checking version strings alone is insufficient.
  • Ask the engineer to open or update the relevant docs PR, link the SDK release, run the docs repository's applicable checks, and follow through on review and merge. If the release needs no docs changes, record that the review was completed.
Acceptance criteria
  • The release instructions clearly assign the docs review/update to the release engineer for every new version release.
  • The reminder identifies the docs repository and covers changed behavior and examples as well as version numbers.
  • Changes are limited to the release guide/checklist.
Lingua principale
Java
Stelle
28
Fork
16
Merge medio
2g 3h
PR unite (30g)
62

Preparare l'ambiente

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 aws/aws-durable-execution-sdk-java

Tutte le issue di aws/aws-durable-execution-sdk-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.