Documentation
Upgrade atlassian-connect-express
If you are creating a new atlassian-connect-express (ACE) add-on, then all you need to do is follow the instructions in the
readme of ACE.
If you have an existing Connect add-on using ACE 0.8.x, follow these steps to update.
- Change the version of
atlassian-connect-expressto~0.9.0inpackage.json - Rename
atlassian-plugin.xmltoatlassian-connect.jsonper our migration guide Specific notes relating to ACE:- You must have the lifecycle
installedevent registered to/installed - Update
routes/index.jsto returnatlassian-connect.jsoninstead of the xml descriptor - Apart from the
{{localBaseUrl}}variable,atlassian-connect.jsonno longer supports substitution fromconfig.json. Any substituted variables will need to be directly placed into your descriptor.
- You must have the lifecycle
- The function
addon.httpClient()now returns a promise to the outgoing request, rather than the request directly. By the time the promise is resolved the request is not writeable, so you must pass in any parameters as part of the first argument toget(),post()etc.
Additionally, we no longer support passing the method type by the 'method' parameter, instead you must call the appropriate function on thehttpClient. For example, code should be migrated from
to:addon.httpClient(req)({ method: 'POST', uri: '/some/url', json: data, userKey: userKey })
Note, thataddon.httpClient(req).post({ uri: '/some/url', json: data, userKey: userKey });httpClientoptions take a userKey object, rather than the username. - Run
npm install - Test with
node app.js