You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -94,6 +94,7 @@ For example:
94
94
mode: id
95
95
docs-dir: '.'
96
96
files-pattern: '*.md'
97
+
ignore: 'node_modules/**;dist/**'
97
98
files-metadata: |
98
99
[
99
100
{
@@ -178,6 +179,7 @@ The action accepts a configuration file in the root of the repository, and it ca
178
179
|`docs-dir`| Path to the directory containing the markdown files |__Yes__||
179
180
|`files-metadata`| Array of objects with the metadata of the files to sync, expressed as an stringified JSON (supports multiline). Each object must have at least the `path` property for identifying the file. For the rest of properties read the [markdown-confluence-sync docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#filesmetadata-property)| No ||
180
181
|`files-pattern`| Pattern to filter the files to sync in flat or id mode | No ||
182
+
|`ignore`| Semicolon separated list of [glob](https://github.com/cowboy/node-globule) patterns to ignore files. Matches are based on the current working directory | No ||
181
183
|`confluence-url`| Confluence base URL |__Yes__||
182
184
|`confluence-root-page-id`| ID of the Confluence page under which the pages will be synchronized |__Yes__||
183
185
|`confluence-space-key`| Key of the Confluence space where the pages will be synced |__Yes__||
@@ -187,7 +189,7 @@ The action accepts a configuration file in the root of the repository, and it ca
187
189
|`confluence-notice-template`| Template string to use for the notice message | No ||
188
190
|`confluence-dry-run`| Dry run mode: Do not update Confluence pages. Only log pages to sync | No |`false `|
|`cwd`| Current working directory. Path from where resolve `docs-dir`, `files-pattern`, and search for the configuration file. It must be relative to the repository folder | No |`.`|
192
+
|`cwd`| Current working directory. Path from where resolve `docs-dir`, `files-pattern`, `ignore`, and search for the configuration file. It must be relative to the repository folder | No |Repository root (`.`)|
191
193
192
194
> [!NOTE]
193
195
> Some markdown-confluence-sync options are not available as inputs in the action, as `preprocessor`. If you need to use them, you can set them in the [configuration file](#configuration-file) or using [environment variables](#environment-variables). Refer to the [Markdown Confluence Sync library docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about all available options.
0 commit comments