Skip to content

Add dry-run option#48

Merged
javierbrea merged 4 commits intoreleasefrom
feat/dry-run-option
Jun 11, 2025
Merged

Add dry-run option#48
javierbrea merged 4 commits intoreleasefrom
feat/dry-run-option

Conversation

@javierbrea
Copy link
Collaborator

Add dry-run option

Description

Added

  • feat: Add dry-run option, enabling to process the markdown files and configuration without connecting to Confluence.

Changed

  • chore(deps): Bump @telefonica/markdown-confluence-sync from 2.0.0 to 2.1.0 (Add dryRun option)

closes #47

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.

@javierbrea javierbrea self-assigned this Jun 10, 2025
@github-actions
Copy link

github-actions bot commented Jun 10, 2025

Check SPDX headers

✅ 24 files have valid headers.

@javierbrea javierbrea requested a review from MiguelJMC7 June 10, 2025 12:28
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new "dry-run" option to allow processing of markdown and configuration files without connecting to Confluence. Key changes include:

  • Adding test cases for the "dry-run" option in unit tests.
  • Fetching and converting the "dry-run" input in the main code.
  • Updating action configuration, README documentation, and the changelog accordingly.

Reviewed Changes

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

Show a summary per file
File Description
test/unit/specs/main.spec.ts Added tests verifying the conversion of "dry-run" inputs.
src/main.ts Introduced parsing of the "dry-run" option and integrated it into the configuration.
package.json Bumped version and updated dependency to include dryRun support.
action.yml Added input specification for "dry-run".
README.md Documented the new "dry-run" option.
CHANGELOG.md Logged the addition of the dry-run feature and dependency bump.
Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)

README.md:193

  • Consider clarifying the differences between 'dry-run' and 'confluence-dry-run' in the README to help users distinguish their behaviors.
| `dry-run` | Process markdown files without sending them to the `confluence-sync` library. Useful to early detection of possible errors in configuration, markdown files, etc. Note that, requests that would be made to Confluence won't be logged, use `confluence-dry-run` for that, which also connects to Confluence to calculate the requests to do | No | |

@github-actions
Copy link

github-actions bot commented Jun 10, 2025

Check License Compliance

✅ There are 772 dependencies with allowed licenses.

⚠️ There are 3 dependencies with dangerous licenses:

  • NPM:@cspell/dict-en-common-misspellings@2.0.11: CC-BY-SA-4.0
    • Transitive dependency of NPM:cspell@8.15.5. Defined in package.json
  • NPM:jsuri@1.3.1: unknown
    • Transitive dependency of NPM:confluence.js@1.7.4. Defined in package.json
  • NPM:exit@0.1.2: unknown
    • Transitive dependency of NPM:jest@29.7.0. 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:@telefonica/markdown-confluence-sync@2.1.0: Error requesting dependencies: 5 NOT_FOUND: dependencies not found

✅ Result: Valid licenses

MiguelJMC7
MiguelJMC7 previously approved these changes Jun 10, 2025
ismtabo
ismtabo previously approved these changes Jun 10, 2025
@javierbrea javierbrea dismissed stale reviews from ismtabo and MiguelJMC7 via 2295b6f June 10, 2025 18:33
@javierbrea javierbrea merged commit da0a3f5 into release Jun 11, 2025
5 checks passed
@javierbrea javierbrea deleted the feat/dry-run-option branch June 11, 2025 05:48
@github-actions github-actions bot locked and limited conversation to collaborators Jun 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants