Allow replacing part of changelogs or commit message using replace_command
Cyclonit opened this issue · comments
Is there an existing issue or pull request for this?
- I have searched the existing issues and pull requests
Feature description
Currently the behaviour of replace and replace_command are inconsistent. replace will replace all matches of pattern with a given string, whereas replace_command replaces the entire string as long as at least one match was found.
See TextProcessor.run:228 for references.
For example, the following changelog.postprocessor will replace the entire changelog instead of only the matched occurrences of <REPO>.
postprocessors = [
{ pattern = '<REPO>', replace_command = 'echo "https://github.com/orhun/git-cliff"' }
]Desired solution
This issue is intended to serve as a place to discuss possible solutions.
Alternatives considered
None
Additional context
No response
The inconsistent behaviour in TextProcessor.run:228 makes coming up with a non-breaking and clean solution difficult. Thus I think we need to decide whether we are willing to do a breaking change. If we are, we could change replace_command to replace each match like replace does.
The switch between the old and new behaviour could be reintroduced by having an alternative match to the current pattern. If pattern is used, the entire string is replaced. If match is used, only the matches are replaced.
Let's not make a breaking change with this one. Can you share some config snippets / usage examples about how the new match option will look like? I would say let's agree on something simple and document both behaviors.
definitely interested in this functionality as I would like to be able to switch out the repo url dynamically from our build system and would rather not have to call another script post changelog generation. I understand the desire to not to introduce a breaking change but surely that's the point of semver. Alternatively adding an additional parameter, or a different replace_ option makes it non breaking but allows introduction of the requested functionality?
And obv supporting env var / shell commands as replace_command does would be key too.
I've done some more thinking on this since opening the issue, and I strongly believe that a breaking change would be the best cause of action. The inconsistent behaviour of replace and replace_command is difficult to reason for. Any attempts I have made to introduce additional parameters that would allow replacing just part of the changelog using external commands were unsuccessful.
The current behaviour of replace_command is needed for use cases like running the entire changelog through external tools like typos. This functionality could easily be achieved by changing the pattern used from .* to (?s:.*). The flag s allows . to match newlines, thus making the pattern match the entire string.
@orhun, could you chime in on this? If a breaking changes is permissible, I'd give implementing it a shot.
I gave this another thought and I guess making a breaking change is tolerable for the sake of having a more consistent functionality. @Cyclonit sure, go ahead!