Inform user of implications of ignoring WorkingCopyCheck's warning

[rjkip]

The WorkingCopyCheck prerequisite warns the user that the user has local modifications. However, the implications of ignoring the check are not made clear. I have seen people assume this is just to warn the user that the user has not committed all changes, and that these changes would not be included in the release. The actual consequence, however, is that the changes are committed when the VcsCommitAction is executed.

I propose to change the current warning message:

- 'Your working directory contains ' . $modCount . ' local modifications, use --'
- . $this->ignoreCheckOptionName.' option to bypass this check',
+ 'Your working directory contains ' . $modCount . ' local modifications. Use --'
+ . $this->ignoreCheckOptionName.' option to bypass this check and commit '
+ . 'the local modifications to the repository',

Thoughts?

[jeanmonod]

Hi @rjkip, thanks for the input. I totally agree with you. It's also why I code this: 823f40d some days ago.
One thing: according to the workflow in use, the release task doesn't always contain a commit task. For example if your release only do a git tag there is no reason to tell the user that the change are going to be commited. So a better message could be:

Your working directory contains XX local modifications. Use --YY option to bypass this check.
WARNING, if your release task include a commit action, the pending changes are going to be included in the release

Could be ok like that for you?

[rjkip]

Yes! Great.

[jeanmonod]

@rjkip do you want to provide a PR and them became one of our contributors? ;)

[rjkip]

Hehe, sure 😉 One PR, coming your way.