orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-12-03 21:14:10 +03:00
Code Issues Projects Releases Wiki Activity

docs(readme): add more regex examples for commit_preprocessors

Browse Source 
Ref: https://github.com/orhun/git-cliff/issues/77#issuecomment-1090552243

[skip ci]
This commit is contained in:
Kaushal Modi 2022-04-06 16:58:27 -04:00 committed by GitHub
parent 2b484f078c
commit 9b83518a59
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -504,15 +504,22 @@ An array of commit preprocessors for manipulating the commit messages before par
Examples:
- `{ pattern = "foo", replace = "bar"}`
- Replace text
- Replace text.
- `{ pattern = 'Merged PR #[0-9]: (.*)', replace = "$1"}`
- Remove prefix
- Remove prefix.
- `{ pattern = " +", replace = " "}`
- Replace multiple spaces with a single space
- Replace multiple spaces with a single space.
- `{ pattern = "\\(#([0-9]+)\\)", replace = "([#${1}](https://github.com/orhun/git-cliff/issues/${1}))"}`
- Replace the issue number with the link
- `{ pattern = "https://github.com/.*/issues/([0-9]+)", replace = "[Issue #${1}]"}`
- Replace the issue link with the number
- Replace the issue number with the link.
- `{ pattern = "https://github.com/[^ ]/issues/([0-9]+)", replace = "[Issue #${1}]"}`
- Replace the issue link with the number.
- `{ pattern = "Merge pull request #([0-9]+) from [^ ]+", replace = "PR # [${1}](https://github.com/orhun/git-cliff/pull/${1}):"}`
- Hyperlink PR references from merge commits.
- `{ pattern = "https://github.com/orhun/git-cliff/commit/([a-f0-9]{7})[a-f0-9]*", replace = "commit # [${1}](${0})"}`
- Hyperlink commit links, with short commit hash as description.
- `{ pattern = "([ \\n])(([a-f0-9]{7})[a-f0-9]*)", replace = "${1}commit # [${3}](https://github.com/orhun/git-cliff/commit/${2})"}`
- Hyperlink bare commit hashes like "abcd1234" in commit logs, with short commit hash as description.
#### commit_parsers