remove hardcoded URL, add instructions, fix tests #35
Conversation
martindstone
requested review from
cristinabuenahora and
jreock
as code owners
| if (!context?.apiBaseUrl) { | ||
| return; | ||
| } | ||
| const getConfluencePluginConfig = async (): Promise<void> => { |
There was a problem hiding this comment.
I think in the long run we'll want to add an abstraction into @cortexapps/plugin-core to retrieve configuration bundles, but for our PoC I think this works, just adding the comment for posterity.
There was a problem hiding this comment.
agreed, ideally we would have some boilerplate to show if various things went horribly wrong
plugins/confluence-plugin/README.md
Outdated
|
|
||
| ### Set your Confluence credentials | ||
|
|
||
| If you are using username and password authentication, type them in to a text editor with a colon (`:`) between them. If you are using SSO, use an API token in place of the password. To create an API token in Confluence by clicking on Security > Create and manage API tokens > Create API token. Once you have your text in your text editor like `myusername@example.com:MySecretPassWordOrToken`, you need to base64 encode it. You can do this using an online tool like [this](https://www.base64encode.org). You will add the base64 encoded value to Cortex as a secret. Copy the base64 encoded value. In Cortex, click on Settings > Secrets > Add secret. In Secret name, type `confluence_secret`, paste the base64 encoded secret into Secret value, and click on Create secret. |
There was a problem hiding this comment.
Nitpick, typo, should be: "To create an API tolein in Confluence, click on Security > Create"
plugins/confluence-plugin/README.md
Outdated
|
|
||
| ### Set your Confluence credentials | ||
|
|
||
| If you are using username and password authentication, type them in to a text editor with a colon (`:`) between them. If you are using SSO, use an API token in place of the password. To create an API token in Confluence by clicking on Security > Create and manage API tokens > Create API token. Once you have your text in your text editor like `myusername@example.com:MySecretPassWordOrToken`, you need to base64 encode it. You can do this using an online tool like [this](https://www.base64encode.org). You will add the base64 encoded value to Cortex as a secret. Copy the base64 encoded value. In Cortex, click on Settings > Secrets > Add secret. In Secret name, type `confluence_secret`, paste the base64 encoded secret into Secret value, and click on Create secret. |
There was a problem hiding this comment.
Also, depending on the version and tenant type of Confluence, they may not have an ability to create the API Keys from Confluence Settings and instead will need to navigate to Profile Menu (upper right) -> Account -> Security -> API Tokens. We could provide both, and then link to Atlassian Docs: https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/
Background
Confluence plugin had a hardcoded URL, marketplace plugins need to work without being recompiled.
This PR
Removed the hardcoded URL and added code to get the URL from a plugin config entity; added instructions to create the plugin config entity if it's not found.
Checklists
Security