Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paddyroddy opened this issue Feb 26, 2025 · 2 comments
Labels
enhancement New feature or request investigate Some investigation is needed question Further information is requested

Comments

@paddyroddy
Copy link
Member

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 UCL-MIRSG/azure-mail#32. The bug was fixed by @matt-graham in #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 paddyroddy added the enhancement New feature or request label Feb 26, 2025
@matt-graham
Copy link
Collaborator

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
Copy link
Collaborator

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.

@samcunliffe samcunliffe added investigate Some investigation is needed question Further information is requested labels May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request investigate Some investigation is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants