UCL-ARC / UCL-ARC/python-tooling

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

Open
#523 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement investigate question
Dominant language
Python
Stars
62
Forks
10
Avg merge
7d 6h
Merged PRs (30d)
6

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the template workflows under {{cookiecutter.project_slug}}/.github/workflows and the related fix in pull request 517. Define how those workflows should be exercised automatically, including the template documentation build, and consider the issue complete when CI reliably catches regressions in the generated project.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.