Add option to include additional files to bump

[ziima]

Description

I'd like to suggest a new option to include additional files to bump commit. This would be especially useful to include changelog or similar release-related files.

Currently, I use --allow-dirty. But that doesn't ensure the changelog is included to the git stage. This may cause the commit/tag to be created without necessary files.

[coordt]

I understand your request. Could you provide some thoughts on how you would like it to work (configurations/settings, failure handling, etc)?

[coordt]

Could the hooks functionality work? You can have a script that will add whatever files you want before the commit.

[ziima]

It seems that could work, I have to try that sometime. Thanks for pointing it out.

[ziima]

OK, I tried hook like:

pre_commit_hooks = [
    "git add CHANGELOG.rst",
]

which works fine. The only problem is that I still have to use --allow-dirty to prevent bump-my-version from failing on changes in repository.

[coordt]

Then there must be other modified files. Add the hook 'git status' to see the state. Might need to run bump my version with -vvv

[ziima]

Nope. It's an inherent feature of the process.

The order of events is:

1. Change the CHANGELOG.rst
2. bump-my-version bump ...
   1. check dirty files
   2. run pre_commit_hooks - would add CHANGELOG.rst

It's the same with setup_hooks.

I think it's OK to have check of dirty files before anything else to prevent unwanted changes to the code. But an option to list files which may be dirty would help. Something like:

# These files are ignored in dirty check, event if --no-allow-dirty.
allow_dirty_files = ['CHANGELOG.rst', 'docs/changelog/*']

[coordt]

Thank you for the two PRs. I've given you write permission to the repository.

Do you think you could create a branch with the changes? It would help us both out.