Let a pipeline set the document version

Aperta Adatta ai principianti
#115 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à
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
python
Ambito
cli, documentation

Direzione di ricerca

Inizia leggendo action.yml, l’implementazione dell’azione normalize-docs e docs/action.md; segui come l’azione passa --document-version a generator-ready. Aggiungi l’input proposto e documentalo. Il lavoro è completo quando una pipeline può impostare la versione del documento e l’intestazione del documento pubblicato la usa al posto del valore predefinito.

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

Descrizione

tech debt
Description of Technical Debt

generator-ready's required document.version comes from --document-version and defaults to 1.0.0. The action
has no input for it, so every technical project a pipeline builds says "version 1.0.0", and
living-doc-generator-markdown prints that in the header.

Impact of Technical Debt
  • Published documents carry a version that means nothing.
Category

Code Quality / Refactoring

Priority

Low - Nice to have

Proposed Solution

A document-version input passed to normalize-docs, documented in docs/action.md. Pick it up when a pilot publishes a release document, or someone asks for the real version.

Effort Estimate

2 hours

Dependencies / Related

No response

Additional Context

Measured 2026-11-12 at living-doc-toolkit fea9aa6 (v0.1.0). Re-check:

grep -n document-version action.yml is empty while this is open.

Lingua principale
Python
Stelle
0
Fork
0
Merge medio
1g 7h
PR unite (30g)
19

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 AbsaOSS/living-doc-toolkit

Tutte le issue di AbsaOSS/living-doc-toolkit

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.