49 lines
2.0 KiB
Markdown
49 lines
2.0 KiB
Markdown
# Development and CI
|
|
|
|
## Project layout
|
|
|
|
| Path | Purpose |
|
|
| --- | --- |
|
|
| `tools/` | Standalone command-line scripts, also importable as Python modules |
|
|
| `tests/` | Standard-library unit tests |
|
|
| `docs/` | Detailed usage and development documentation |
|
|
| `Jenkinsfile` | Test-only Jenkins pipeline |
|
|
| `AGENTS.md` | Contributor instructions and commit policy |
|
|
|
|
Run the commands below from the repository root. No Python package installation
|
|
is needed. To run an individual suite, use
|
|
`python3 -m unittest -v tests.test_exporter` or
|
|
`python3 -m unittest -v tests.test_pptx_videos`.
|
|
|
|
## Tests
|
|
|
|
Run the same suite locally and in Jenkins:
|
|
|
|
```sh
|
|
python3 -m unittest discover -s tests -v
|
|
```
|
|
|
|
Tests cover export validation, overwrite handling, failed conversions, PPTX
|
|
discovery and slide order, temporary video cleanup, report formats, and PDF
|
|
compiler invocation, Ontime event mapping, and terminal progress cleanup.
|
|
External CLI calls are mocked: CI does not require FFmpeg,
|
|
Typst, DeckCraft, or PdfCraft and does not claim to verify rendering fidelity.
|
|
|
|
## Jenkins
|
|
|
|
The declarative `Jenkinsfile` uses the `rust_no_docker` worker label and requires
|
|
Git and Python 3.9 or newer. It performs a clean SCM checkout, checks Python,
|
|
and runs the standard-library unit tests. No packages are installed.
|
|
|
|
This is a test-only pipeline on every configured branch: no build artifacts,
|
|
archives, publication, badges, or Checks API calls. Status is reported in Jenkins.
|
|
There are no pipeline credential bindings; SCM access uses the Jenkins job's
|
|
configured repository credentials.
|
|
|
|
Configure a Pipeline from SCM or multibranch job for this repository with
|
|
`Jenkinsfile` as the script path (`main` is the default branch). For a Gitea-aware
|
|
multibranch job, use the installation's Jenkins base URL plus
|
|
`/gitea-webhook/post` as the Gitea webhook target and enable push events.
|
|
The Jenkins administrator must supply the actual reachable URL and SCM
|
|
credentials. This repository does not create the job or register the webhook.
|