Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitdde8ffe

Browse files
fairbanksgoknozor
authored andcommitted
feat: add additional package path filtering options
1 parentf818bf2 commitdde8ffe

File tree

3 files changed

+202
-30
lines changed

3 files changed

+202
-30
lines changed

‎docs/website/config/README.md‎

Lines changed: 54 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#Configuration reference
22

3-
The config reference list all value that can be set in the`cog.toml` file at the root of a repository.
3+
The config reference list all value that can be set in the`cog.toml` file at the root of a repository.
44

55
##General
66

@@ -18,16 +18,16 @@ The config reference list all value that can be set in the `cog.toml` file at th
1818

1919
[Userguide->Tagprefix](../guide/#tag-prefix)
2020

21-
### `branch_whitelist`
22-
21+
### `branch_whitelist`
22+
2323
- Type: `Array<String>`
2424
- Optional: `true`
25-
- Description: A list of glob patterns to allow bumping only on matching branches.
26-
- Example:
25+
- Description: A list of glob patterns to allow bumping only on matching branches.
26+
- Example:
2727
```toml
2828
branch_whitelist = ["main","release/**" ]
2929
```
30-
- Also see:
30+
- Also see:
3131

3232
[Userguide->Branchwhitelist](../guide/#branch-whitelist)
3333

@@ -50,16 +50,16 @@ The config reference list all value that can be set in the `cog.toml` file at th
5050
- Type: `Hashmap<String, CommitType>`
5151
- Optional: `true`
5252
- Description: extend the allowed commit types, creating a new `cog commit` command and allowing to generate changelog entries for the
53-
given type. Can also be used to override the default commit types.
54-
- Example:
53+
given type. Can also be used to override the default commit types.
54+
- Example:
5555
```toml
5656
[commit_types]
5757
hotfix = {changelog_title ="Hotfixes" }
5858
chore = {changelog_title ="Hotfixes",omit_from_changelog =true }
5959
release = {changelog_title ="Releases" }
6060
```
61-
- Also see:
62-
61+
- Also see:
62+
6363
[Userguide->Customcommittypes](../guide/#custom-commit-types)
6464

6565
### `changelog_title`
@@ -76,7 +76,7 @@ The config reference list all value that can be set in the `cog.toml` file at th
7676
### `omit_from_changelog`
7777
- Type: `Bool`
7878
- Optional: `true`
79-
- Default value: `false`
79+
- Default value: `false`
8080
- Description: do not generate changelog entries for the given commit type.
8181
- Example:
8282
```toml
@@ -127,7 +127,7 @@ The config reference list all value that can be set in the `cog.toml` file at th
127127
* [User guide -> Post-bump hooks](../guide/#post-bump-hooks)
128128
* [User guide -> Version DSL](../guide/#version-dsl)
129129

130-
### `bump_profiles`
130+
### `bump_profiles`
131131

132132

133133
- Type: `Hashmap<String, BumpProfile>`
@@ -142,7 +142,7 @@ The config reference list all value that can be set in the `cog.toml` file at th
142142
"cargo fmt --all",
143143
"cargo bump {{version}}",
144144
]
145-
145+
146146
post_bump_hooks = [
147147
"cargo package",
148148
"cargo publish"
@@ -156,7 +156,7 @@ The config reference list all value that can be set in the `cog.toml` file at th
156156
* [User guide -> Version DSL](../guide/#version-dsl)
157157
* [User guide -> Bump profiles](../guide/guide/#bump-profiles)
158158

159-
### `skip_ci`
159+
### `skip_ci`
160160

161161
- Type: `String`
162162
- Optional: `true`
@@ -168,11 +168,11 @@ The config reference list all value that can be set in the `cog.toml` file at th
168168
- Also see:
169169
* [User guide -> Make Cocogitto skip CI CD](../guide/#make-cocogitto-skip-ci-cd)
170170

171-
### `skip_untracked`
171+
### `skip_untracked`
172172

173173
- Type: `boolean`
174174
- Optional: `true`
175-
- Default value: `false`
175+
- Default value: `false`
176176
- Description: Allows to perform bump even if there are untracked or uncommited changes.
177177
- Example:
178178
```toml
@@ -181,11 +181,11 @@ The config reference list all value that can be set in the `cog.toml` file at th
181181
- Also see:
182182
* [User guide -> Skip untracked or uncommited changes](../guide/#skip-untracked-or-uncommited-changes)
183183

184-
### `disable_changelog`
184+
### `disable_changelog`
185185

186186
- Type: `boolean`
187187
- Optional: `true`
188-
- Default value: `false`
188+
- Default value: `false`
189189
- Description: Disable changelog generation when bumping.
190190
- Example:
191191
```toml
@@ -217,7 +217,7 @@ The config reference list all value that can be set in the `cog.toml` file at th
217217
- Default value: `"default"`
218218
- Description: name of the builtin template to use for changelog generation or path to a custom template.
219219
Note that `remote`, `repository` and `owner` are mandatory if the "remote" built-in template us used or if your
220-
custom template make use of those variables.
220+
custom template make use of those variables.
221221
- Built-in templates : `default`, `remote`, `full_hash`
222222
- Example:
223223
```toml
@@ -235,7 +235,7 @@ The config reference list all value that can be set in the `cog.toml` file at th
235235
- Type: `String`
236236
- Optional: `true`
237237
- Description: domain name of the git platform hosting the repository, used for Markdown link generation in changelogs.
238-
when provided `repository` and `owner` are also required.
238+
when provided `repository` and `owner` are also required.
239239
- Example:
240240
```toml
241241
[changelog]
@@ -351,11 +351,11 @@ The config reference list all value that can be set in the `cog.toml` file at th
351351
"cargo set-version {{version}}",
352352
]
353353
```
354-
354+
355355
## Mono-repository packages
356356

357357
### `path`
358-
358+
359359
- Type: `String`
360360
- Optional: `false`
361361
- Description: set the package path.
@@ -364,7 +364,33 @@ The config reference list all value that can be set in the `cog.toml` file at th
364364
[packages]
365365
my_package = {path ="packages/my_package" }
366366
```
367-
367+
368+
###`include`
369+
370+
- Type:`Array<String>`
371+
- Optional:`true`
372+
- Description: an array of additional path globs to consider part of the package.
373+
These additional paths will trigger a package version bump in addition to the path in`path`.
374+
The globs are evaluated with[globset](https://crates.io/crates/globset) with the`literal_separator` option enabled.
375+
- Example:
376+
```toml
377+
[packages]
378+
my_package = {path ="packages/my_package",include = ["common/**"] }
379+
```
380+
381+
###`ignore`
382+
383+
- Type:`Array<String>`
384+
- Optional:`true`
385+
- Description: an array of path globs to ignore as part of the package.
386+
These paths will never trigger a package version bump (even if they normally would based on`path` and`include`).
387+
The globs are evaluated with[globset](https://crates.io/crates/globset) with the`literal_separator` option enabled.
388+
- Example:
389+
```toml
390+
[packages]
391+
my_package = {path ="packages/my_package",include = ["packages/my_package/.github/**"] }
392+
```
393+
368394
###`changelog_path`
369395

370396
- Type:`String`
@@ -409,9 +435,9 @@ The config reference list all value that can be set in the `cog.toml` file at th
409435
* [User guide -> Automatic versioning for monorepo](../guide/#packages-hooks)
410436
* [User guide -> Post-bump hooks](../guide/#post-bump-hooks)
411437
* [User guide -> Version DSL](../guide/#version-dsl)
412-
438+
413439
### `post_bump_hooks`
414-
440+
415441
- Type: `Array<String>`
416442
- Optional: `true`
417443
- Description: an array of command to execute after a version bump.
@@ -427,7 +453,7 @@ The config reference list all value that can be set in the `cog.toml` file at th
427453
* [User guide -> Automatic versioning for monorepo](../guide/#packages-hooks)
428454
* [User guide -> Post-bump hooks](../guide/#post-bump-hooks)
429455
* [User guide -> Version DSL](../guide/#version-dsl)
430-
456+
431457
### `bump_profiles`
432458

433459
- Type: `Hashmap<String, BumpProfile>`
@@ -438,14 +464,14 @@ The config reference list all value that can be set in the `cog.toml` file at th
438464
```toml
439465
[packages.my-package]
440466
path ="packages/my-package"
441-
467+
442468
[bump_profiles.hotfix]
443469
pre_bump_hooks = [
444470
"cargo build --release",
445471
"cargo fmt --all",
446472
"cargo set-version {{version}}",
447473
]
448-
474+
449475
post_bump_hooks = [
450476
"cargo package",
451477
]

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp