search

con / duct

A helper to run a command, capture stdout/stderr and details about running
MIT License
1 stars 1 forks source link

Add --version and auto-update README (enforced) #57

Closed asmacdo closed 3 weeks ago

asmacdo commented 3 weeks ago

Fixes https://github.com/con/duct/issues/48 Fixes #59

asmacdo commented 3 weeks ago

Marked as draft to include auto readme update https://github.com/con/duct/issues/59

asmacdo commented 3 weeks ago

On last change needed-- run the script in gh actions and assert no diff.

asmacdo commented 3 weeks ago

The new CI check updates the README.md with the contents of duct --help

the diff

 -optional arguments:
+options:

in python 3.10 Argparse changed how they format helptext https://github.com/python/cpython/issues/53903

option 1: we can either ignore that particular line, (but that will cause it to possibly change back and forth, so not ideal)

option 2: we lock python version in CI and in precommit to 3.10+, which is also not ideal

option 3 : we use python version in gh action check >= 3.10, but don't enforce python version in the precommit. We document that developers should undo that line if running precommit with python < 3.10

All 3 options are gross to me, but i lean option 3. @yarikoptic ideas, thoughts?

yarikoptic commented 3 weeks ago

All 3 options are gross to me, but i lean option 3. @yarikoptic ideas, thoughts?

option 3 sounds good enough for me too!

yarikoptic commented 3 weeks ago

Note that original PR intent/description (Add --version) is far from its current purpose/changes.