backstage/.changeset/cool-beans-tap.md

@backstage/plugin-scaffolder-backend-module-confluence-to-markdown

@backstage/plugin-scaffolder-backend-module-confluence-to-markdown
minor

BREAKING

This change updates the configuration of the confluence-to-markdown action so that it does not conflict with other confluence plguins. Currently many plugins make use of the confluence.auth configuration. However, only the confluence-to-markdown action uses the confluence.auth as a string. This change updates it so that confluence.auth is an object.

Required Changes

Below are examples for updating bearer, basic, and userpass implementations.

For bearer: Before:

confluence:
  baseUrl: 'https://confluence.example.com'
  auth: 'bearer'
  token: '${CONFLUENCE_TOKEN}'

After:

confluence:
  baseUrl: 'https://confluence.example.com'
  auth:
    type: 'bearer'
    token: '${CONFLUENCE_TOKEN}'

For basic:

Before:

confluence:
  baseUrl: 'https://confluence.example.com'
  auth: 'basic'
  token: '${CONFLUENCE_TOKEN}'
  email: 'example@company.org'

After:

confluence:
  baseUrl: 'https://confluence.example.com'
  auth:
    type: 'basic'
    token: '${CONFLUENCE_TOKEN}'
    email: 'example@company.org'

For userpass Before:

confluence:
  baseUrl: 'https://confluence.example.com'
  auth: 'userpass'
  username: 'your-username'
  password: 'your-password'

After:

confluence:
  baseUrl: 'https://confluence.example.com'
  auth:
    type: 'userpass'
    username: 'your-username'
    password: 'your-password'