Dual declaration of directories in Makefile is a foot gun
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77.2k
- Forks
- 36k
- PR merge metrics
- PR metrics pending
Description
I'd estimate that 90% of the times that I introduce a new directory to the Python project, I forget that Python requires a two-phase operation to add new directories:
- Add the directory and files to the Git repo.
- Add a reference to the new directory to the Makefile.
If one completes only the first step, the tests will pass locally and in CI, but will fail in buildbots after merging. See https://github.com/python/cpython/pull/102010 for the most recent example.
Ideally, the build system should be reconfigured such that only one phase is required to add a new directory to the build.
Short of that, the CI builds should somehow check that the introduction of a new directory either triggers the buildbot "installed" builds or otherwise checks that the new directories are included in any source bundle.
It should not be a common occurrence to introduce a directory, pass CI, and then fail buildbots.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining the Makefile and the buildbot "installed" builds or source-bundle checks mentioned in the issue. Determine whether the build can discover new directories automatically or whether CI can detect directories missing from the build, then verify the chosen approach with a newly introduced directory.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, ci-cd
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100