executablebooks / cookiecutter-jupyter-book

Cookiecutter template for a simple jupyter book
https://executablebooks.github.io/cookiecutter-jupyter-book/
BSD 3-Clause "New" or "Revised" License
140 stars 53 forks source link

This template makes a GitHub Action that expects a .pre-commit-config.yaml, but doesn't make one #46

Open jpivarski opened 1 month ago

jpivarski commented 1 month ago

Describe the bug

In a repo created by the template, the PR branch Action attempts to run pre-commit, but it immediately encounters the error,

=====> .pre-commit-config.yaml is not a file

(because there is no such file). Either pre-commit should be automatically added to Actions and configured, or neither.

It's also interesting that I'm seeing this in my first PR branch, but not any direct commits to main.

(It's hard to discover these issues without a guinea pig!)

Reproduce the bug

See above.

List your environment

Not relevant.