Remove the one-off tutorial workflow

Open Beginner friendly
  • Is something wrong?
#133 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
github-actions, yaml
Domain
ci-cd

Research direction

The workflow to remove is .github/workflows/tutorial-by-tag.yml, which runs on every pull request. Confirm the file is still tracked with git ls-files .github/workflows/tutorial-by-tag.yml, then read the issue's linked run and #107 for context. Done means the workflow file is deleted and no pull request check runs it, or, if the alternative is chosen, .github/CONTEXT.md names it with the pin-update step added.

Written by the indexing model from the issue text.

Description

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.

Dominant language
Python
Stars
0
Forks
0
Avg merge
6h 14m
Merged PRs (30d)
27

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/living-doc

All issues in AbsaOSS/living-doc

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.