Repository navigation
redirect repo #2003
Description
Hello,
I wonder if it's possible to redirect a repo URL in the pre-commit-config file: this might be useful if the developer of a hook
moves the repo home repository, for example from github to gitlab. Can this be implemented by adding a redirect_repo key
(or something) in the .pre-commit-hooks.yaml file of the old repository? As a reference here is one of my hooks with the new key:
- id: md-toc
name: Update markdown table-of-contents
description: 'Replace TOC marker with a table of contents'
language: python
types: [markdown] # as detected by pre-commit with identify-cli
entry: md_toc
args: [-p, github]
redirect_repo: https://some.other.url/frnmst/md-tocThis feature should work with the autoupdate command. Things like infinite redirects must be avoided of course.
What do you think?
Activity
asottile commentedon Aug 9, 2021
there's a couple of issues:
.pre-commit-hooks.yamland no good place to put the value (would probably need to move to top-level map which is a big change)what do you think?
frnmst commentedon Aug 9, 2021
Yes it's tricky. What about something simpler: adding an option that prints a notice (something like: "the repo url has changed to https://x.y.z please change your configuration") when autoupdate is run? As you say, if
.pre-commit-hooks.yamlis not the right place maybe a new file like.pre-commit-updates.yamlis. A developer could add a notice not just when a repository is migrated, but also if a major change in a configuration file used by a hook is to be doneasottile commentedon Aug 9, 2021
I'd rather not add a new file just for this.
what I've done in the past for this is use the
namefield of hooks to communicate deprecation -- and then when fully sunset change them tolanguage: failhooks -- pre-commit/pre-commit-hooks did this for examplefrnmst commentedon Aug 10, 2021
Thank you I'll try that.