Remove the one-off tutorial workflow

Aperta Adatta ai principianti
  • Qualcosa non va?
#133 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à
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
78/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github-actions, yaml
Ambito
ci-cd

Direzione di ricerca

Il workflow da rimuovere è .github/workflows/tutorial-by-tag.yml, che viene eseguito a ogni pull request. Conferma che il file sia ancora tracciato con git ls-files .github/workflows/tutorial-by-tag.yml, poi leggi l'esecuzione collegata nell'issue e #107 per il contesto. Il lavoro è completo quando il file del workflow è stato eliminato e nessun controllo di pull request lo esegue, oppure, se si sceglie l'alternativa, quando .github/CONTEXT.md lo nomina e il passaggio di aggiornamento del pin è stato aggiunto.

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

Descrizione

type:tech-debt
Description of Technical Debt

#107 added .github/workflows/tutorial-by-tag.yml to run the tutorial's workflow
(docs/tutorials/gh-source-to-markdown.md § 2) once, with the three actions called by tag over the testbed's
core at 36a0ee6. Its run was green, and its six files were byte-identical to the release milestone's release-view
documents: https://github.com/AbsaOSS/living-doc/actions/runs/43265924867. The commit that was to delete the workflow
never landed, so it is on master and runs on every pull request. #107's body also links no run (it still carries a
<RUN_URL> placeholder); the link above is that run.

Impact of Technical Debt
  • About a minute of CI on every pull request, and a red check if a released tag or the pinned testbed commit changes.
  • No page names the workflow, so it reads as a standing check nobody decided on.
Category

DevOps / Infrastructure

Priority

Medium - Should be addressed soon

Proposed Solution

Delete .github/workflows/tutorial-by-tag.yml. Alternative, if the tutorial should stay proven on every PR: keep it, name it in .github/CONTEXT.md, and move its testbed commit and tags in each release's pin PR.

Effort Estimate

1 hour

Dependencies / Related

#106, #107

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

git ls-files .github/workflows/tutorial-by-tag.yml prints the path while this is open.

Lingua principale
Python
Stelle
0
Fork
0
Merge medio
6h 14m
PR unite (30g)
27

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

Tutte le issue di AbsaOSS/living-doc

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.