Skip to content

Conversation

@javierbrea
Copy link
Collaborator

@javierbrea javierbrea commented Oct 17, 2025

Support different authentication methods

Description

confluence-sync

  • feat: Add authentication options (OAuth2, Basic, JWT). Deprecate personalAccessToken.
  • feat: Use confluence.js library to retrieve also data about page children, not only pages. The new version 2.1.0 of confluence.js supports passing pagination options to get all children pages.
  • chore: Update confluence.js to 2.1.0

markdown-confluence-sync

  • feat: Update confluence-sync to 2.1.0. Add authentication options (OAuth2, Basic, JWT). Deprecate personalAccessToken.
  • feat: Add warning when using the deprecated personalAccessToken option.

dev tools

  • chore: Remove renovate config

closes #56

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 Oct 17, 2025
Copilot AI review requested due to automatic review settings October 17, 2025 12:12
@javierbrea javierbrea added the feature request New feature request label Oct 17, 2025
@javierbrea javierbrea linked an issue Oct 17, 2025 that may be closed by this pull request
1 task
@github-actions
Copy link

github-actions bot commented Oct 17, 2025

Check SPDX headers

✅ 245 files have valid headers.

Copy link
Contributor

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 support for multiple authentication methods (OAuth2, Basic, JWT) to the confluence-sync and markdown-confluence-sync libraries, while deprecating the personalAccessToken option in favor of a more flexible authentication configuration object.

Key changes:

  • Added new authentication options (OAuth2, Basic, JWT) and deprecated personalAccessToken
  • Updated confluence.js dependency from 1.7.4 to 2.1.0 to support pagination options for retrieving child pages
  • Improved error handling and messaging throughout the codebase

Reviewed Changes

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

Show a summary per file
File Description
components/confluence-sync/src/confluence/CustomConfluenceClient.ts Adds authentication type guards and refactors client initialization to support multiple auth methods with backward compatibility
components/confluence-sync/src/confluence/CustomConfluenceClient.types.ts Defines new authentication configuration types for OAuth2, Basic, and JWT methods
components/confluence-sync/src/confluence/errors/*.ts Refactors error classes to extend CustomError and improves error message handling
components/markdown-confluence-sync/src/lib/confluence/ConfluenceSync.ts Adds authentication option handling and deprecation warning for personalAccessToken
components/*/README.md Updates documentation with new authentication configuration examples
components/*/CHANGELOG.md Documents the new features and changes
components/*/test/** Updates tests to cover new authentication methods and error handling
Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions
Copy link

github-actions bot commented Oct 17, 2025

Check License Compliance

✅ There are 1450 dependencies with allowed licenses.

⚠️ There are 5 dependencies with dangerous licenses:

✅ Result: Valid licenses

@javierbrea javierbrea merged commit a0c87be into main Oct 20, 2025
11 checks passed
@javierbrea javierbrea deleted the feat/56/custom-auth-methods branch October 20, 2025 06:58
@github-actions github-actions bot locked and limited conversation to collaborators Oct 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

feature request New feature request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature]: Allow customizing the authentication method

3 participants