Skip to content
QuantEconPublic

About

Reusable GitHub Actions for QuantEcon lecture builds

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

281 Commits

Folders and files

Repository files navigation

QuantEcon Actions

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.

Documentation

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:

The developer docs cover how the project is designed, tested and maintained, and the work plan.

Who uses them

The lecture repositories that use these actions are tracked in QuantEcon/meta#321, and the versions they pin in the work plan.

Standalone actions

QuantEcon's actions outside the lecture pipeline each live in a repository of their own, as ARCHITECTURE.md describes. This table lists them, and each repository's README is the reference for its inputs.

Action What it does Ref consumers use Maintainer Test consumer Main consumers
action-translation Translates the lectures a merged pull request changed and opens a pull request in each translated edition, reviews those pull requests, and rebases the open ones when one merges @v0 mmcky test-translation-sync, with its .zh-cn, .fa and .ml targets Sync: lecture-python-intro, lecture-python.myst, lecture-python-programming. Review and rebase: lecture-intro.zh-cn, lecture-python.zh-cn, lecture-python-programming.{fa,fr,ja,ml,zh-cn}
action-style-guide Checks a lecture against QuantEcon's style guide when an issue comment names it @v0.7.3 mmcky test-action-style-guide lecture-python-advanced.myst
action-link-checker Checks the links in a built site's HTML, and suggests a fix for each broken or redirected one @v1 mmcky Its own CI, on the fixtures in its tests/ lecture-python-intro, lecture-python-advanced.myst, lecture-python-programming, continuous_time_mcs (at @v1.2.0)

Contributing

CONTRIBUTING.md covers the development workflow, testing a change from a lecture repository, and the release steps, including the staged release and moving v0.

License

MIT: see LICENSE.

Support

Open an issue in this repository. To report a security vulnerability, follow SECURITY.md instead.

About

Reusable GitHub Actions for QuantEcon lecture builds

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages