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
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
# Markdown Confluence Sync action
4
4
5
-
This action syncs markdown files to Confluence using the [Markdown Confluence Sync](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync) library.
5
+
This action syncs markdown files to Confluence using the [Markdown Confluence Sync](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync) library.
6
6
7
7
## Table of contents
8
8
@@ -33,7 +33,7 @@ This action syncs markdown files to Confluence using the [Markdown Confluence Sy
33
33
***flat**: Synchronize a list of markdown files matched by a [glob pattern](https://github.com/isaacs/node-glob#glob-primer) as children page of a Confluence root page, without any hierarchy. It is also possible to provide a Confluence id to some pages to update them directly, as in the id mode.
34
34
35
35
> [!NOTE]
36
-
> Read the [Markdown Confluence Sync library documentation](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync) for detailed information about all features and configuration options.
36
+
> Read the [Markdown Confluence Sync library documentation](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync) for detailed information about all features and configuration options.
37
37
38
38
## Usage
39
39
@@ -76,7 +76,7 @@ docs/
76
76
```
77
77
78
78
> [!TIP]
79
-
> Read the [tree mode docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#tree-mode) for further information about configuration options and how to organize your markdown files.
79
+
> Read the [tree mode docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#tree-mode) for further information about configuration options and how to organize your markdown files.
80
80
81
81
### Id operation mode
82
82
@@ -179,7 +179,7 @@ The action accepts a configuration file in the root of the repository, and it ca
179
179
|------|-------------|----------|---------|
180
180
|`mode`| Operation mode: `tree`, `id` or `flat`| No |`tree`|
181
181
|`docs-dir`| Path to the directory containing the markdown files |__Yes__||
182
-
|`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 ||
182
+
|`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/confluence-tools/tree/main/components/markdown-confluence-sync#filesmetadata-property)| No ||
183
183
|`files-pattern`| Pattern to filter the files to sync in flat or id mode | No ||
184
184
|`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 ||
185
185
|`confluence-url`| Confluence base URL |__Yes__||
@@ -194,7 +194,7 @@ The action accepts a configuration file in the root of the repository, and it ca
194
194
|`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 (`.`) |
195
195
196
196
> [!NOTE]
197
-
> 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.
197
+
> 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/confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about all available options.
198
198
199
199
### Configuration file
200
200
@@ -219,13 +219,13 @@ module.exports = {
219
219
```
220
220
221
221
> [!NOTE]
222
-
> Read 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 the configuration file.
222
+
> Read the [Markdown Confluence Sync library docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#configuration-file) for further info about the configuration file.
223
223
224
224
### Environment variables
225
225
226
226
The action can be configured using environment variables. The environment variables must be prefixed with `MARKDOWN_CONFLUENCE_SYNC_` and use uppercase letters.
227
227
228
-
Read the [Markdown Confluence Sync library docs](https://github.com/Telefonica/cross-confluence-tools/tree/main/components/markdown-confluence-sync#environment-variables) for further info about environment variables.
228
+
Read the [Markdown Confluence Sync library docs](https://github.com/Telefonica/confluence-tools/tree/main/components/markdown-confluence-sync#environment-variables) for further info about environment variables.
0 commit comments