markdown-confluence-sync v2.1.0

[javierbrea]

markdown-confluence-sync v2.1.0

Description

• feat: Add dryRun option to markdown-confluence-sync

Agreement

Please check the following boxes after you have read and understood each item.

• I have read the CONTRIBUTING document
• I have read the CODE_OF_CONDUCT document
• I accept that, by signing the Contributor License Agreement through a comment in the PR, my Github user name will be stored by in a branch of this repository for future reference.

In case this is your first contribution to this project, you will also have to add a comment with the following text: "I have read the CLA Document and I hereby sign the CLA", otherwise the PR status will fail and our bot will request you to add it. Once you have signed it in a PR, you will not have to sign it again for future contributions.

[Copilot]

Pull Request Overview

This PR introduces a new "dryRun" option to allow processing markdown files without applying changes to Confluence, which is useful for testing configurations. Key changes include:

• Addition of unit and component tests to verify the dryRun behavior.
• Extension of the configuration and type definitions to include a dryRun option.
• Updates to README and CHANGELOG documentation to reflect the new functionality.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
components/markdown-confluence-sync/test/unit/specs/MarkdownConfluenceSync.test.ts	Added unit test ensuring sync is not called when dryRun is enabled
components/markdown-confluence-sync/test/component/specs/dryRun.spec.ts	Added component tests for dryRun behavior with appropriate error and log checks
components/markdown-confluence-sync/test/component/fixtures/dry-run/markdown-confluence-sync.config.cjs	Introduced dryRun configuration in fixture for component tests
components/markdown-confluence-sync/src/lib/MarkdownConfluenceSync.types.ts	Extended type definitions to include dryRun option
components/markdown-confluence-sync/src/lib/MarkdownConfluenceSync.ts	Incorporated dryRun logic to bypass Confluence sync calls
components/markdown-confluence-sync/README.md	Updated documentation to cover both dryRun and confluence.dryRun options
components/markdown-confluence-sync/CHANGELOG.md	Logged new feature entry for dryRun

Comments suppressed due to low confidence (1)

components/markdown-confluence-sync/README.md:286

• Consider clarifying the distinction between the dryRun and confluence.dryRun options, as their purposes may be confusing to users. You might add a brief note that explains the different behaviors and use cases for these options.

| `dryRun` | `boolean` | Process markdown files without sending them to `confluence-sync`. Useful to early detection of possible errors in configuration, etc. Note that, requests that would be made to Confluence won't be logged, use `confluence.dryRun` for that, which also connects to Confluence to calculate the requests to do | `false` |

[github-actions]

Check SPDX headers

✅ 242 files have valid headers.

[github-actions]

Check License Compliance

✅ There are 1437 dependencies with allowed licenses.

⚠️ There are 5 dependencies with dangerous licenses:

• NPM:@cspell/[email protected]: CC-BY-SA-4.0
  • Transitive dependency of NPM:[email protected]. Defined in package.json
• NPM:[email protected]: unknown
  • Transitive dependency of NPM:[email protected]. Defined in components/confluence-sync/package.json, components/markdown-confluence-sync/package.json
• NPM:[email protected]: unknown
  • Transitive dependency of NPM:@mermaid-js/[email protected]. Defined in components/markdown-confluence-sync/package.json
• NPM:[email protected]: unknown
  • Transitive dependency of NPM:[email protected]. Defined in components/markdown-confluence-sync/package.json
• NPM:[email protected]: unknown
  • Transitive dependency of NPM:[email protected]. Defined in package.json

‼️ There were some issues while verifying the licenses. This can occasionally occur if a dependency was recently released, as the dependency graph may not yet be fully updated.

Errors:

• NPM:[email protected]: Error requesting dependencies: 5 NOT_FOUND: dependencies not found
• NPM:@types/[email protected]: Error requesting dependencies: 5 NOT_FOUND: dependencies not found

✅ Result: Valid licenses