docformatter icon indicating copy to clipboard operation
docformatter copied to clipboard

Official release still broken with pre-commit (1.7.6?)

Open Eutropios opened this issue 1 year ago • 2 comments

Despite the commit modifying docformatter to allow for it to work with pre-commit 4.0, this commit has not been shipped as an official release. Is there any chance we could get a 1.7.6 release with the latest commit to allow us to continue using docformatter as a pre-commit hook with 4.0?

Eutropios avatar Oct 14 '24 00:10 Eutropios

Just a note, all that's required for pre-commit's autoupdate is to make a new tag in the repo. If folks want to avoid a full release when there may not be changes to the underlying package, that is.

I propose a v1.7.5-post1?

As a workaround, folks can target rev: "master" in their configs.

Edit: the most recent commit sha can also be used: rev: "eb1df347edd128b30cd3368dddc3aa65edcfac38"

GriceTurrble avatar Oct 17 '24 11:10 GriceTurrble

@weibullguy, you were the one who merged the PR that fixed the issue on the master branch. Do you have permissions to create a new tag/release?

nfelt14 avatar Oct 21 '24 21:10 nfelt14

@weibullguy, you were the one who merged the PR that fixed the issue on the master branch. Do you have permissions to create a new tag/release?

Hi, I was wondering if there's any updates on bumping the version?

jkanche avatar Nov 04 '24 19:11 jkanche

Hi, I see that there was some activity regarding this problem, are there no official news when the new release is planned?

Niegazowana avatar Nov 25 '24 13:11 Niegazowana

Does anyone know who the primary maintainer of this package is so that we can get some progress made on this issue?

nfelt14 avatar Jan 08 '25 00:01 nfelt14

Seriously, how are PRs being merged, but no releases are happening?

mjspeck avatar Jan 16 '25 19:01 mjspeck

It"s possible to use the commit sha instead of the version in pre-commit:

  - repo: https://github.com/PyCQA/docformatter
    rev: eb1df347edd128b30cd3368dddc3aa65edcfac38 # Don't autoupdate until https://github.com/PyCQA/docformatter/issues/293 is fixed
    hooks:
      - id: docformatter

(But pre-commit autoupdate will use a tag even if it's less recent than the sha)

Pierre-Sassoulas avatar Jan 21 '25 23:01 Pierre-Sassoulas

any chance to have 1.7.6 released, it is very annoying to revert every pre-commit bump to SHA since 1.7.5 is broken 🤔

Borda avatar Apr 08 '25 10:04 Borda

For anyone still looking for a workaround, you can use master's most recent commit hash eb1df347edd128b30cd3368dddc3aa65edcfac38 in .pre-commit-config.yaml

Specifically, I updated my configuration to:

repos:
  - repo: https://github.com/PyCQA/docformatter
    rev: eb1df347edd128b30cd3368dddc3aa65edcfac38
    hooks:
      - id: docformatter
        args: [ --in-place, --recursive ]

JacksonElia avatar Apr 21 '25 19:04 JacksonElia

as was already said above: this is not an actual fix, because now you can not use pre-commit autoupdate any longer, as

But pre-commit autoupdate will use a tag even if it's less recent than the sha

and, personally at that point I decided to rather give up on docformatter than autoupdate (especially since the former seems to become unmaintained)

felixhekhorn avatar Apr 22 '25 11:04 felixhekhorn

and, personally at that point I decided to rather give up on docformatter than autoupdate (especially since the former seems to become unmaintained)

Do you by chance know any adequate replacements?

juhannc avatar Apr 22 '25 11:04 juhannc

Do you by chance know any adequate replacements?

no - but I haven't searched properly yet to be fair

felixhekhorn avatar Apr 22 '25 11:04 felixhekhorn

and, personally at that point I decided to rather give up on docformatter than autoupdate (especially since the former seems to become unmaintained)

Do you by chance know any adequate replacements?

I've since switched to ruff, while not exactly the same, does most of what docformatter does. This issue might provide more details - https://github.com/astral-sh/ruff/issues/1335

jkanche avatar Apr 22 '25 13:04 jkanche

as was already said above: this is not an actual fix, because now you can not use pre-commit autoupdate any longer, as

But pre-commit autoupdate will use a tag even if it's less recent than the sha

and, personally at that point I decided to rather give up on docformatter than autoupdate (especially since the former seems to become unmaintained)

I switched to using HEAD which will let you use pre-commit autoupdate but you now get a warning.

nabobalis avatar May 01 '25 01:05 nabobalis

@weibullguy or anyone still active with this org, could you pls consider creating an new release/tag so people would update/fix their workflows?

Borda avatar May 06 '25 08:05 Borda

This has been fixed with the latest 1.7.6 release. Thanks all.

Eutropios avatar May 07 '25 20:05 Eutropios