python-tooling icon indicating copy to clipboard operation
python-tooling copied to clipboard

Is it possible to run the `{{cookiecutter.project_slug}}/.github/workflows` in CI?

Open paddyroddy opened this issue 9 months ago • 2 comments

Is Your Feature Request Related to a Problem? Please Describe

I was helping @ruaridhg with a repo that was built using an old version of the cookiecutter https://github.com/UCL-MIRSG/azure-mail/pull/32. The bug was fixed by @matt-graham in https://github.com/UCL-ARC/python-tooling/pull/517.

Describe the Solution You'd Like

What would be really good if there was a way we could run the workflows within the template. I'm not sure how we would do this in an automated fashion. Currently, the template docs are never built, which is how this bug wasn't fixed for a while.

Describe Alternatives You've Considered

No response

Additional Context

No response

paddyroddy avatar Feb 26 '25 12:02 paddyroddy

Just to note that as part of #517 a test was added which does build the docs for the template by creating a temporary virtual environment, installing tox, running tox -e docs and checking there are no errors, which should give us a bit more early visibility on things which break within the code / configuration that the tox docs environment touches. This does still however leave the actual GitHub Actions workflow files untested but providing these are largely just using pre-baked actions and then running a tox command hopefully it's less likely things will break there. Would be ideal to test the template workflows too though.

matt-graham avatar Feb 26 '25 14:02 matt-graham

Relatedly, we don't seem to currently have the template tests triggered to run on a cron schedule, which would also be helpful in giving earlier indication of when things are broken by changes in upstream depedencies like cookiecutter, MkDocs and tox.

matt-graham avatar Feb 26 '25 14:02 matt-graham