[Feature]: Link to an issue through commit messages

[philou]

Contact Details

No response

Feature Request

At the moment, it is not possible to link a TCR commit to any issue (Github, Jira, or whatever).

Feature Description

The standard way to link a commit with an issue is by adding an issue ID tag in the commit message (#xxx). Convention Commits suggests adding this meta-information in the footer https://www.conventionalcommits.org/en/v1.0.0-beta.2/

We will provide a new command line option to specify a suffix to all commit messages. We'll append the suffix as a new line at the end of the commit message footer, without any modification. Ex:

Running: tcr --message-suffix "Issue #999999"

✅ TCR - tests passing

changed-lines:
    src: 3
    test: 0
test-stats:
    run: 11
    passed: 11
    failed: 0
    skipped: 1
    error: 0
    duration: 0s

Issue #999999

We will not allow to provide this value from the config, to avoid 'forgetting' about it.
Users will have to stop and start TCR again if they want to change the commit message suffix.

Alternatives

We have been thinking where to put this issue tag in the message, and envisioned a title prefix, a first line, or even making it configurable. We decided to stick to Conventional Commits.

Additional Context

Write your answer here.

Code of Conduct

• I agree to follow this project's Code of Conduct

To Do

• Add new command line interface parameter
  • Ensure the parameter is not persisted in the configuration
• Update the commit messages with the value of the 'message-suffix'
  • If 'message-suffix' is not provided we should not change the default behavior
• Separate the stats from the message footer
• Display suffix message in session summary when entering TCR
• Update the documentation for this option (will be done through the setup of the new command line parameter)

Warning

• ⚠ Using this feature with suffix message containing space characters will require to evolve tcrw scripts so that command line parameters containing spaces are properly forwarded to the TCR executable