sphinx-contrib / confluencebuilder

Confluence Markup Builder Plugin for Sphinx
BSD 2-Clause "Simplified" License
315 stars 99 forks source link

Introduce confluence api token option #992

Closed jdknight closed 3 months ago

jdknight commented 3 months ago

The following introduces the option confluence_api_token to this extension. The goal is somewhat of a replacement of the option confluence_server_pass. For Confluence Cloud, API tokens are required for authentication. For Confluence Data Center, PATs are preferred although there may be some level of support for passwords.

The option confluence_server_pass was one of the original options introduced by this extension. Over the years there has been a transition towards tokens, so a rename may be best. Specifically, there seem to be cases where people place API tokens in the personal access token (PAT) option but should have been under the "pass" option. Having the option explicitly say "API token" should provide some clarify.

Note that confluence_api_token should be functionally the same as using confluence_server_pass, so existing environments should not require any immediate changes. Over time, confluence_server_pass may be deprecated.