Correct the README Continuous integration section #39

Merged
Tirsvad merged 1 commits from fix-readme-ci-section into main 2026-10-07 19:35:12 +02:00
Owner

Correct the README Continuous integration section

The README's "Continuous integration" section and its project layout still described the workflow as it was before #35: they named .github/workflows/ci.yml, said it is read by GitHub Actions and Gitea Actions, and said CI runs the Doxygen build. The workflow is now .gitea/workflows/ci.yml, it runs on Gitea Actions, and it has no Doxygen step. RC-018 and RC-019 both noted the mismatch.

Change

Only README.md:

  • The section names .gitea/workflows/ci.yml, says it runs on every push and every pull request, and lists what it runs: pytest, ruff (lint and format check) and mypy after setting up Python 3.13 and installing the project with its development tools.
  • It says plainly that CI does not build the source documentation and points to doxygen Doxyfile in the next section.
  • A second paragraph says why the file is under .gitea/workflows: GitHub does not run it, and pushing to the GitHub mirror needs no workflow permission.
  • The project layout line is .gitea/workflows/ci.yml.

Everything else in the README is unchanged, including "Run the tests", whose "same checks as in continuous integration" is still correct.

Verification

  • The old path and the old claims appear nowhere else in the README.
  • The README is the Doxygen main page, so the documentation was rebuilt: doxygen Doxyfile prints no warning.
  • pytest still passes (95 tests). No code, no workflow and no other document changes.
  • CI runs on this pull request.

Not changed

Older documents still mention the old path or CI building the documentation: the Business Case scope, MIL-001 task 5 and RC-018. They are Accepted or historical records and are left as they are.

Issues

No issue closed: this pull request corrects documentation, and every issue of the project is already closed.

## Correct the README Continuous integration section The README's "Continuous integration" section and its project layout still described the workflow as it was before #35: they named `.github/workflows/ci.yml`, said it is read by GitHub Actions and Gitea Actions, and said CI runs the Doxygen build. The workflow is now `.gitea/workflows/ci.yml`, it runs on Gitea Actions, and it has no Doxygen step. `RC-018` and `RC-019` both noted the mismatch. ### Change Only `README.md`: - The section names `.gitea/workflows/ci.yml`, says it runs on every push and every pull request, and lists what it runs: pytest, ruff (lint and format check) and mypy after setting up Python 3.13 and installing the project with its development tools. - It says plainly that CI does not build the source documentation and points to `doxygen Doxyfile` in the next section. - A second paragraph says why the file is under `.gitea/workflows`: GitHub does not run it, and pushing to the GitHub mirror needs no workflow permission. - The project layout line is `.gitea/workflows/ci.yml`. Everything else in the README is unchanged, including "Run the tests", whose "same checks as in continuous integration" is still correct. ### Verification - The old path and the old claims appear nowhere else in the README. - The README is the Doxygen main page, so the documentation was rebuilt: `doxygen Doxyfile` prints no warning. - `pytest` still passes (95 tests). No code, no workflow and no other document changes. - CI runs on this pull request. ### Not changed Older documents still mention the old path or CI building the documentation: the Business Case scope, `MIL-001` task 5 and `RC-018`. They are Accepted or historical records and are left as they are. ### Issues No issue closed: this pull request corrects documentation, and every issue of the project is already closed.
Tirsvad added 1 commit 2026-10-07 19:34:45 +02:00
Correct the README Continuous integration section
CI / checks (push) Successful in 46s
CI / checks (pull_request) Successful in 49s
382d799dfe
The section and the project layout still named .github/workflows/ci.yml and said CI
builds the documentation. The workflow is .gitea/workflows/ci.yml, runs on Gitea
Actions, and runs pytest, ruff and mypy; it has no Doxygen step, so the README now
points to doxygen Doxyfile and says why the file is not under .github/workflows.
Tirsvad merged commit f3a7d8f77b into main 2026-10-07 19:35:12 +02:00
Sign in to join this conversation.
No Reviewers
No labels
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Tirsvad-Udemy-100-days-of-code/018-turtle#39