Improve documentation for replace and replace_command

[Cyclonit]

Is there an existing issue or pull request for this?

• I have searched the existing issues and pull requests

Feature description

changelog.postprocessors and git.commit_preprocessors work on the entire changelog or git message respectively. The documentation does not clearly describe this. As a first time user, one might expect that either processor only affects the part of the input that actually matches the pattern.

For example, a postprocessor like the following would be expected to replace all occurrences of <REPO> with https://github.com/orhun/git-cliff. It replaces the entire changelog instead.

postprocessors = [
  { pattern = '<REPO>', replace_template = 'https://github.com/orhun/git-cliff' }
]

Desired solution

The documentation should be revised in all places to clearly state that pattern does not limit the scope of the replacement, but instead is only used to check if a given string is supposed to replaced entirely.

Alternatives considered

None

Additional context

No response

[orhun]

Agreed. We can also mention something like:

{ pattern = '.*', replace_command = 'typos --write-changes -' }

is the equivalent of:

echo "<matched_part_of_the_changelog>" | typos --write-changes -

Marked as good first issue, feel free to tackle this as well!

[Muhammad-Owais-Warsi]

Hi @orhun, for some reason, I don't have clarity on the issue, but I would love to tackle this. Could you please provide more details? Thanks!

[orhun]

Hey @Muhammad-Owais-Warsi! You can start off by adding my comment above to the documentation for making things more clear. Also see the replace_command examples in various places to get an idea of what we are trying to improve here :)

[Muhammad-Owais-Warsi]

So basically I have to make changes here , as mentioned in the comment by you and @Cyclonit . Like in this command https://git-cliff.org/docs/configuration/git and under the commit_preprocessors, I have to mention about the changelog.postprocessors

[orhun]

Yeah, at there and other relevant sections in the documentation. I would recommend trying out this feature for yourself to get a more clear idea about what to do here ;)

[Muhammad-Owais-Warsi]

Hey, I have made some little changes in the documentation addressing the issue mentioned above.

1. The commit_preprocessors section.

2. In the commit_parsers section.

Let me know whether the changes are correct and if any other parts of the documentation need updates. Thanks!

[orhun]

We can use "commit message" instead of "commit log". Other than that it seems fine, please send a PR - it is easier to discuss on the changes :)

[Muhammad-Owais-Warsi]

Sure @orhun

[Muhammad-Owais-Warsi]

In my PR #928 this test got failed. I tried to ran rustfmt, but no processing took place, but my formatting got passed.

[orhun]

That's fine. Can also mention #609 (comment) in your PR?

[Muhammad-Owais-Warsi]

#928