Composite GitHub Actions, workflow templates and container images that build, preview and publish QuantEcon's lecture sites. One weekly cache build executes every lecture, so pull-request and publish builds re-execute only the lectures that changed.
The actions are built for QuantEcon's lecture repositories, and are on 0.x, where a minor release can change what an action does. Using them elsewhere is fine, but unsupported. Releases are listed in the CHANGELOG and on the releases page; @v0 follows the latest.
The user manual covers using the actions. Its index lists every action, each has a chapter with every input and output, and a step uses one as quantecon/actions/<action>@v0. These guides cover the rest:
- Getting started: setting up a lecture repository with the workflow templates, and moving an existing one onto the actions.
- How the actions compose: the chain from the cache build to a preview or publish.
- Containers: the two images,
ghcr.io/quantecon/quanteconandghcr.io/quantecon/quantecon-build. - Versioning:
@v0against an exact release. - Security: fork pull requests, secrets, and what each job can reach.
The developer docs cover how the project is designed, tested and maintained, and the work plan.
The lecture repositories that use these actions are tracked in QuantEcon/meta#321, and the versions they pin in the work plan.
CONTRIBUTING.md covers the development workflow, testing a change from a lecture repository, and the release steps, including the staged release and moving v0.
MIT: see LICENSE.
Open an issue in this repository. To report a security vulnerability, follow SECURITY.md instead.