Orhun Parmaksız
848d8a587e
docs(config): add minimal example
2022-01-29 18:53:26 +03:00
Orhun Parmaksız
dce09d71a0
docs(readme): update template contexts about link_parsers
2022-01-17 00:21:37 +03:00
Orhun Parmaksız
dcb3141ac9
style(readme): update the styling
2022-01-17 00:17:54 +03:00
Pascal Bach
b88e7d30be
feat(changelog): add link_parsers
for parsing/extracting links ( #42 )
...
* feat(core): add link parsing
Searches for patterns in commite messages and allows to convert them into
links via regular expression replacement.
This allows to include links to issue trackers and other tools in the resulting
changelog.
Closes #41
* fix(ci): update lychee arguments
* docs(readme): fix typos
* docs(readme): fix typos
Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
2021-12-31 21:10:37 +03:00
Orhun Parmaksız
47d124add2
docs(readme): update --with-commit
example in README.md
2021-12-11 19:19:42 +03:00
Orhun Parmaksız
e4c60b20be
feat(args): add --with-commit
argument for including custom commit messages in changelog
2021-12-11 19:14:49 +03:00
Orhun Parmaksız
8445313b13
feat(changelog): support having both conventional and unconventional commits in the changelog
2021-12-11 15:07:10 +03:00
Kenji Miyake
de11ccecac
feat(config): add ignore_tags
option ( #40 )
...
* feat: add ignore_tags option
Resolves (#36 )
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
* test: add a test using GitHub Actions
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
* docs: fix style
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
* chore: add ignore_tags to example config files
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
* style: refactor test-fixtures workflow
Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
2021-12-07 21:49:37 +03:00
Orhun Parmaksız
02a6187a58
feat(args): add --current
flag for processing the current tag ( #37 )
2021-12-02 10:01:10 +03:00
Orhun Parmaksız
7b000ad43e
style(args)!: rename --commit-path
argument to --include-path
2021-12-01 22:58:49 +03:00
Orhun Parmaksız
25a1d49c09
feat(args): add --exclude-path
argument for excluding related commits
2021-12-01 22:50:12 +03:00
Orhun Parmaksız
edb343a10e
feat(args): support multiple values for --commit-path
argument
2021-11-30 16:31:19 +03:00
Orhun Parmaksız
ad11cbf6c5
feat(args): accept glob patterns for --commit-path
argument
2021-11-30 16:05:29 +03:00
Orhun Parmaksız
4eb334da06
feat(config): support specifying the sorting methods in config ( #31 )
2021-11-25 22:45:44 +03:00
Orhun Parmaksız
cc09d637ff
feat(changelog): add --topo-order
flag for sorting tags ( #29 )
2021-10-30 01:02:00 +03:00
Orhun Parmaksız
2925340368
docs(readme): update GitLab CI/CD section
2021-10-19 21:17:18 +03:00
alteregoart
90a87c5874
docs(readme): add GitLab CI/CD section to README.md ( #24 )
...
Co-authored-by: Arthur Dion <dion@eurecom.fr>
2021-10-19 21:12:57 +03:00
Taylan Dogan
2950a412c2
feat(changelog): add --sort
argument for sorting commits ( #15 )
...
* refactor(changelog): sort commits by newest in CHANGELOG
Previously, cliff was sorting the commits by oldest first.
Like:
```
- Support parsing the missing scopes with `default_scope` (#8 )
- Support generating a changelog scoped to a directory (#11 )
```
As the PR numbers indicate, the first bullet point is definitely
older than the latter.
With this update, it will look like this:
```
- Support generating a changelog scoped to a directory (#11 )
- Support parsing the missing scopes with `default_scope` (#8 )
```
Signed-off-by: Taylan Dogan <git@taylandogan.info>
* refactor: add sorting flag
I don't expect any other sorting types will be added
so the logic consist of checking whether it is
`newest` or not.
One could argue with why wouldn't I make this a boolean.
My answer would be, in my opinion, it lose its meaning
because this is not something we want to enable or disable
but something that we want to decide which pattern
we want to use. So it is more like a semantic choice.
Signed-off-by: Taylan Dogan <git@taylandogan.info>
* docs(readme): move the explanation of sort flag to README.md
Co-authored-by: orhun <orhunparmaksiz@gmail.com>
2021-09-28 22:58:05 +03:00
orhun
b193f42e25
docs(readme): add "build from source" section to README.md
2021-09-28 01:27:09 +03:00
orhun
9022af533d
docs(readme): mention the signing key for binary releases ( #17 )
2021-09-22 00:32:24 +03:00
orhun
5409e06e4c
docs(readme): add packaging status badge to installation section
2021-09-21 16:43:18 +03:00
orhun
f64459dd9f
docs(readme): add raw/rendered output for scoped-sorted example
2021-09-21 16:40:47 +03:00
Matt Foxx
05584b614a
docs(config): Add scope-sorted example ( #16 )
...
* Same as basic example but sorts commit by sorted scope
* Defaults to "No Category" if no scope found on commit
* Adds a nested bullet for breaking change description
2021-09-21 16:17:39 +03:00
orhun
0bb7c910b4
feat(changelog): support generating a changelog scoped to a directory ( #11 )
2021-09-09 00:34:25 +03:00
orhun
f420a5ac6c
docs(readme): update example regexes
2021-09-08 21:58:02 +03:00
Steven L
8a18e4d48d
fix(config): fix default regexes and references in docs ( #7 )
...
* Fix default regexes and references in docs
* correction: I didn't realize the colon was necessary
* change more tomls, fmt
* rebase fixes
2021-09-08 21:40:29 +03:00
orhun
b5edfc279d
docs(readme): add badge for joining the Matrix chat
2021-09-08 14:20:45 +03:00
orhun
b5df656e61
feat(changelog): support parsing the missing scopes with default_scope
( #8 )
2021-09-07 00:23:08 +03:00
orhun
8fb18b7848
docs(readme): update installation instructions for Arch Linux
2021-09-04 20:40:04 +03:00
orhun
4398828df7
docs(readme): update docker commands to only mount the .git directory
2021-09-04 17:20:36 +03:00
orhun
4c6e64bd13
docs(readme): update template examples to mention how to contribute
2021-08-21 00:48:21 +03:00
orhun
6fa5d288d3
docs(readme): mention breaking changes for templating
2021-08-21 00:43:28 +03:00
orhun
927776b9db
style(args): update the message of --init
flag
2021-08-18 23:51:11 +03:00
orhun
210b634113
feat(config): support a global location for configuration file ( #2 )
2021-08-18 23:46:37 +03:00
orhun
183481bac3
feat(config): add --init
flag for creating the default config
2021-08-18 03:51:04 +03:00
orhun
acda1954dc
chore(config): move cliff.toml
to config/
2021-08-17 21:49:21 +03:00
orhun
f1b495d7b1
docs(readme): add installation instructions for the AUR
2021-08-12 20:13:18 +03:00
orhun
6e6bddeadd
docs(readme): add preview image to README.md
2021-08-08 22:23:13 +03:00
orhun
441ed4d8b4
docs(readme): update detailed template example
2021-08-03 00:34:54 +03:00
orhun
dfab97842f
style(readme): remove quotes from rendered output
2021-08-03 00:29:32 +03:00
orhun
ed010be74f
fix(example): remove symbolic link
2021-08-03 00:27:07 +03:00
orhun
a406158608
docs(readme): add examples for templating
2021-08-03 00:21:05 +03:00
orhun
32f837e3f0
docs(readme): add examples for CLI usage
2021-07-22 23:30:51 +03:00
orhun
2f2b2fc50a
docs(readme): update README.md about template and examples
2021-07-18 19:00:02 +03:00
orhun
fa6a38b339
style(readme): wrap table of contents into summary
2021-07-14 22:49:22 +03:00
orhun
1cf1ac73fa
style(readme): remove comments from template context
2021-07-14 22:45:50 +03:00
orhun
37494901ef
style(readme): update the comments in template context
2021-07-14 22:21:13 +03:00
orhun
f08ff0c413
style(readme): center the badges
2021-07-14 21:53:00 +03:00
orhun
7f4a9c2012
docs(readme): update README.md about usage
2021-07-14 21:38:53 +03:00
orhun
9fc08f4c50
feat(changelog): support setting the body template via args
2021-06-20 16:57:26 +03:00