Skip to content

Conversation

@bearomorphism
Copy link
Collaborator

Description

Checklist

Code Changes

  • Add test cases to all the changes you introduce
  • Run poetry all locally to ensure this change passes linter check and tests
  • Manually test the changes:
    • Verify the feature/bug fix works as expected in real-world scenarios
    • Test edge cases and error conditions
    • Ensure backward compatibility is maintained
    • Document any manual testing steps performed
  • Update the documentation for the changes

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
  • Check and fix any broken links (internal or external) in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO    -  Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Expected Behavior

Steps to Test This Pull Request

Additional Context

@bearomorphism
Copy link
Collaborator Author

@noirbizarre

Is there a recommended or simpler way to regenerate all file-regression (golden) test files across all supported Python versions?

I tried using tox, but since I’m not very familiar with it yet, my current attempt tox -- tests/commands/test_common_command.py --regen-all only runs the environments that are already available locally and silently skips the rest.

image

If the expected workflow requires contributors to install every supported Python version locally in order to regenerate these files, that may become a significant barrier for future contributors.

I'd appreciate guidance on the intended workflow here, or whether regeneration is expected to happen in CI instead.

@bearomorphism bearomorphism changed the base branch from v4-11-0 to master December 29, 2025 11:10
@noirbizarre
Copy link
Member

Oh that's a good question 🤔

Wait a bit, I'll submit a PR with a dedicated helper today, I have an idea for that.

@bearomorphism
Copy link
Collaborator Author

Sure, thanks 🙇

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants