orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-10-26 07:49:41 +03:00
Code Issues Projects Releases Wiki Activity

docs(website): fix the documentation for --include-path (#567)

Browse Source 
* docs: fix the documentation for `--include-path`

Related to #48

* style: update styling

---------

Co-authored-by: Orhun Parmaksız <orhunparmaksiz@gmail.com>
This commit is contained in:
Amin Yahyaabadi 2024-03-22 07:23:56 -07:00 committed by GitHub
parent 172cae1650
commit 4a7aa7e91f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/docs/usage/monorepos.md
View File

@ -4,9 +4,16 @@ sidebar_position: 5
# Monorepos
You can generate a changelog scoped to a specific directory:
You can generate a changelog scoped to a specific directory via `--include-path` and `--exclude-path`.
This requires changing the current working directory to the target folder. The included/excluded paths must be relative to the repository's root.
```bash
git cliff --include-path "**/*.toml" --include-path "*.md"
git cliff --exclude-path ".github/*"
cd packages/some_library
git cliff --include-path "packages/some_library/**/*" --repository "../../"
```
```bash
cd packages/some_library
git cliff --include-path "packages/some_library/**/*" --repository "../../" --exclude-path ".github/*"
```