Build Status for Confluence allows you to embed a lozenge into a Confluence page showing the current status of a particular build.
Table of Contents |
---|
Installation
Build Status for Confluence is available to be installed throughout the UPM in the Atlassian Marketplace.
Administrators
Once installed - a new menu option is available in the Confluence Administration area labeled "Build Status Configuration".
Configuring available Bamboo servers
In order for an Atlassian Bamboo Server to be available to be selected - the Application Link (for more information about Application Links - please see https://confluence.atlassian.com/display/APPLINKS/Application+Links+Documentation ) has to be a Trusted Application or have an oAuth authorization set up.
Configuring available Jenkins servers
The configuration screen will ask you for the following pieces of information for each Jenkins server configuration:
- Name
- Base URL
- Username
- Password
Please note the user credentials are stored as plain text in the database.
Embedding in a page
To embed in a page:Supported build servers include Bamboo and Jenkins.
Table of Contents |
---|
Displaying build status lozenge in a Confluence page
From the Macro Browser pick "Build Status" | ||
Pick your build server (if you have multiples) then pick your build plan. | Save and view |
Finally, save and view!
Configuration options for Jenkins
Status | ||||
---|---|---|---|---|
|
In version 1.1 we introduced the capability to set the Socket and Connection time outs to Jenkins servers. By default this value is 10000ms (10 secs) for both. If you need to increase this, you can do this by clicking on the cogwheel and specifying the values. Note: Making this too high might cause issues with your Confluence instance serving threads being held up by the Jenkins server. Make it too low and you'll see more timeouts.
The main Jenkins configuration screen with the cogwheel | Specify the the values and click save |
---|---|
Definitions
Connection Timeout - This is the maximum time (in ms) that the service will wait to attempt to establish a connection to the remote server.
Socket Timeout - This is the maximum time (in ms) that the service will wait for the next packet of data to be received from the remote server.
Troubleshooting
Issue | Resolution |
---|---|
I don't see the build servers I expect in the drop down | In order for a Bamboo server to be viewable you need to set up a Trusted application or oAuth relationship in Application Links. This configuration can be implemented at the global Confluence admin level. |
I don't see the build plans I expect in the drop down | For Bamboo, you will only be able to retrieve the build plans that you have access to. Ask your Bamboo build plan administrator to ensure that the Bamboo build plan permissions are set appropriately. |
I can't see the build status lozenge | For Bamboo, you will only be able to see lozenges for the build plans that you have access to view. Ask your Bamboo build plan administrator if you can be granted access to view the status lozenges. |