Development

Tests

The tests stub Selenium, Playwright, undetected-chromedriver and requests_cache, so they run without a browser or a network:

pip install -r requirements-test.txt
pytest tests/ --cov=src

tests/test_web_mirror.py holds 68 tests covering all four scripts in src/: the sitemap reading, the video download, the output paths, the link rewriting and each script's entry point. codecov.yml sets a 90% coverage target for the project and for each pull request.

Continuous integration

Workflow	Runs on	What it does
tests.yml	every pull request, and pushes to main	the tests on Python 3.12, then the coverage upload to Codecov
docs.yml	every pull request, and pushes to main that touch docs/, mkdocs.yml, nginx/default.conf or the workflow	the strict build of this site; on main, the deploy to GitHub Pages
docker-publish.yml	a v*.*.* tag, and pushes to main that touch the Dockerfile, requirements.txt, src/ or the workflow	builds the linux/amd64 image and pushes it to Docker Hub
dockerhub-description.yml	pushes to main that touch README.md	copies the README to the Docker Hub page

Releases

A release is a tag. Push vX.Y.Z on main and docker-publish.yml publishes the image as X.Y.Z and vX.Y.Z; a push to main that changes the image also moves latest. There is no version file and no changelog; the GitHub release notes say what changed.

The docs

The site is built with MkDocs and Material from docs/:

pip install -r docs/requirements-docs.txt
mkdocs serve        # http://127.0.0.1:8000/web-mirror/
mkdocs build        # strict: a broken link, a missing page or a page left out of the nav fails it

A page is a lowercase file in docs/ listed in the nav of mkdocs.yml and linked from the home page.

Dependencies

Dependabot opens pull requests for new versions of the Python packages (requirements.txt and docs/requirements-docs.txt, major versions ignored), the Dockerfile base image and the workflow actions.

Security

Report a vulnerability as the security policy says, never in a public issue.