Tirsvad-Udemy-100-days-of-code/018-turtle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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
Conversation 0 Commits 1 Files Changed 1
+4 -2
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -2
View File
@@ -117,7 +117,9 @@ mypy
## Continuous integration ## Continuous integration
`.github/workflows/ci.yml` runs on every push to `main` and on every pull request. It is read by both GitHub Actions and Gitea Actions. It sets up Python 3.13, upgrades `pip`, installs the project with its development tools, then runs ruff (lint and format check), mypy, pytest and the Doxygen build. No step opens a turtle window. `.gitea/workflows/ci.yml` runs on Gitea Actions on every push and on every pull request. It sets up Python 3.13, upgrades `pip`, installs the project with its development tools, then runs pytest, ruff (lint and format check) and mypy. It does not build the source documentation: run `doxygen Doxyfile` yourself, as the next section shows. No step opens a turtle window.
The workflow lives in `.gitea/workflows` and not in `.github/workflows`, so GitHub does not run it and pushing to the GitHub mirror needs no workflow permission.
## Build the source documentation ## Build the source documentation
@@ -133,7 +135,7 @@ Open `build/html/index.html` in a browser. Any Doxygen warning fails the build,
```text ```text
. .
├── .github/workflows/ci.yml continuous integration ├── .gitea/workflows/ci.yml continuous integration
├── docs/ project documents: business case, plan, milestones ├── docs/ project documents: business case, plan, milestones
├── src/turtle_challenges/ the package ├── src/turtle_challenges/ the package
│ ├── constants.py every constant of the project │ ├── constants.py every constant of the project