DOC: update developer instructions for prek and autofix.ci - #315
Draft
redeboer wants to merge 3 commits into
Draft
DOC: update developer instructions for prek and autofix.ci#315redeboer wants to merge 3 commits into
redeboer wants to merge 3 commits into
Conversation
redeboer
force-pushed
the
prek-and-autofix-ci
branch
from
September 10, 2026 09:46
da256c2 to
c1195ad
Compare
redeboer
added this pull request to stack #316
September 10, 2026 09:46
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #313
Tip
See preview here.
This branch runs against the tips of the two upstream migration PRs, so that their implementation can be tested end-to-end. Both pins have to be replaced with a release before this PR is merged:
.pre-commit-config.yaml:ComPWA/policyata7f74b7(ENH: switch toprekpolicy#695), also reflected in thetool.tombi.schemasURL inpyproject.toml..github/workflows/ci.ymland.github/workflows/autofix.ci.yml:ComPWA/actionsataa47e7f(ENH: run style checks with prek actions#178).📝 Documentation
docs/develop.mdis updated for the new developer setup:uv tool install prekandprek install --prepare-hooks.pre-commit-uvis gone, since prek usesuvnatively.(pre-commit)=target keeps the oldhttps://compwa.github.io/develop#pre-commitanchor alive, and all in-page{ref}cross-references are updated todevelop:Prek. The section documentsprek run --all-files, states that.pre-commit-config.yamland the hook definitions are unchanged, and adds two admonitions: one on replacing thepre-commitGit hook shims under.git/hooks(eitherprek install --prepare-hooksagain, orpolicy migrate, following the behaviour implemented in ENH: switch toprekpolicy#695), and one on prek's workspace mode and the.prekignorefile that a repository with a nested.pre-commit-config.yamltest fixture needs.poe style,pixi run style, andprek run --all-filesare equivalent, and describes theupgradetask with its_upgrade-prekhelper (prek autoupdate -j8). "Pinning dependency versions" mentions thatlock.ymlbumps hook revisions withuvx prek autoupdate.pushjob could not, that the workflow file name is load-bearing, that no patch is applied when the last four commits were authored by a bot, and thatstyle.ymlskips its ownpushjob when it detects the workflow.🖱️ Developer experience
[tool.poe.tasks.style]runsprek run --all-files, and_upgrade-precommitbecomes_upgrade-prekwithprek autoupdate -j8. The rename and theCONTRIBUTING.mdupdate are whatcheck-dev-fileswrites with the new policy; thestyletask body is not generated by policy and is edited by hand.README.mdswaps the pre-commit.ci badge for a prek badge.prekandprekignoreare added to.cspell.json.⚙️ CI
.github/workflows/autofix.ci.yml, taken from the template in ENH: run style checks with prek actions#178. It runsprek run --all-files, updates the Jupyter kernel names withupload-artifact: false, and hands the patch to autofix.ci.ci:block is removed from.pre-commit-config.yaml, which retires pre-commit.ci for this repository.get-skipped-pre-commit-hooksthen reportsALL, so the style job runs the fullpoe styleinstead of only the hooks that pre-commit.ci skipped.🚧 Action needed outside this repository
ci:block does not stop the app: it still runs on every pull request, and it now runs the hooks that theskip:list used to hold back. Those hooks need network access that pre-commit.ci does not grant, so its check on this PR fails oncheck-jsonschemaandtombi. Disabling the app in the repository settings resolves it; the equivalent checks already run instyle.yml.autofix.ciGitHub App has to be installed for the workflow to commit anything.Validation
prek run --all-filespasses.poe docbuilds without warnings, and the builtdevelop.htmlcontains thepre-commit,prek, andautofix-cianchors.poe linkcheckpasses.workflow_dispatchrun ofci.ymlon this branch (run 34461762380) passes with the prek-basedstyle.yml. BothUpdate Jupyter kernelsandPush changesare skipped, which is thehas-autofix-cidetection from ENH: run style checks with prek actions#178 working as intended.ci.ymlandautofix.ci.ymlonly trigger on pull requests againstmain,epic/*, or ax.y.xbranch, so neither runs on this pull request while it is stacked on MAINT: upgrade lock files #314. The dispatch above is the substitute for thestyle.ymlhalf;autofix.cican only be exercised once the base ismainand the app is installed.🤖 Generated with Claude Code
https://claude.ai/code/session_01JhTXb2pf4HiV92gpxG6wmi