Adding a column to the branch listing

Bitbucket Server provides a listing of all the branches within a repository. It is a useful view for providing relevant information associated with branches. Bitbucket Server ships with a number of useful metadata columns already but by implementing a few plugin points you can add your own.

In order to display information in the table you will need to implement three plugin points:

• A ref metadata provider - to provide data to use in the table
• A client web section - to add a column to the table
• A client web panel - to add content to the cell in your column

src/main/resources/atlassian-plugin.xml

​x
 
1
<atlassian-plugin name="Branch colors plugin" key="example.plugin.branch.colors" plugins-version="2">
2
    <plugin-info>
3
        <description>A plugin which labels branches with a color</description>
4
        <vendor name="My Company" url="http://www.mycompany.com"/>
5
        <version>1.0</version>
6
    </plugin-info>
7
​
8
    <!-- Metadata provider. The branch listing page will invoke this as part its rendering -->
9
    <ref-metadata-provider key="color" class="branch.colors.RefColorProvider" />
10
​
11
    <!-- Table column -->
12
    <client-web-section key="color-column" name="Branch list color column" weight="50" location="bitbucket.branches.extras">
13
        <label key="example.plugin.branches.col.color">Color</label>
14
    </client-web-section>
15
​
16
    <!-- Web panel + soy template. The location attribute must correspond to the client-web-section above -->
17
    <client-web-panel key="color-cell" name="Branch list color cell" location="color-column" weight="10">
18
        <resource name="view" type="soy" location="example.plugin.branch.colors:color-cell-templates/example.plugin.branch.colors.cell"/>
19
        <dependency>example.plugin.branch.colors:color-cell-templates</dependency>
20
    </client-web-panel>
21
​
22
    <client-resource key="color-cell-templates" name="Color cell templates">
23
        <resource type="download" name="color-cell.soy.js" location="/color-cell.soy" />
24
        <dependency>com.atlassian.bitbucket.server.bitbucket-web:global</dependency>
25
    </client-resource>
26
​
27
</atlassian-plugin>

src/main/java/branch/colors/RefColorProvider.java

48
 
1
package branch.colors;
2
​
3
import com.atlassian.bitbucket.repository.Ref;
4
import com.atlassian.bitbucket.repository.RefMetadataContext;
5
import com.atlassian.bitbucket.repository.RefMetadataProvider;
6
​
7
import java.nio.charset.Charset;
8
import java.security.MessageDigest;
9
import java.security.NoSuchAlgorithmException;
10
import java.util.HashMap;
11
import java.util.Map;
12
​
13
public class RefColorProvider implements RefMetadataProvider<String> {
14
​
15
    private static final String DEFAULT_COLOR = "#cccccc";
16
​
17
    // This provider relies on no other components but could via constructor injection
18
​
19
    @Override
20
    public Map<Ref, String> getMetadata(RefMetadataContext context) {
21
        Map<Ref, String> colors = new HashMap<Ref, String>(context.getRefs().size());
22
        for (Ref ref : context.getRefs()) {
23
            String color;
24
​
25
            try {
26
                MessageDigest md5 = MessageDigest.getInstance("MD5");
27
                color = "#" + asHex(md5.digest(ref.getId().getBytes(Charset.defaultCharset()))).substring(0, 6);
28
            } catch (NoSuchAlgorithmException e) {
29
                color = DEFAULT_COLOR;
30
            }
31
​
32
            colors.put(ref, color);
33
        }
34
        return colors;
35
    }
36
​
37
    private static String asHex(byte[] bytes) {
38
        StringBuilder str = new StringBuilder(bytes.length * 2);
39
        for (byte aByte : bytes) {
40
            int b = 0xff & aByte;
41
            if (b < 16) {
42
                str.append('0');
43
            }
44
            str.append(Integer.toHexString(b));
45
        }
46
        return str.toString();
47
    }
48
}

src/main/resources/color-cell.soy

10
 
1
{namespace example.plugin.branch.colors}
2
​
3
/**
4
 * @param branch
5
 **/
6
{template .cell}
7
// metadata is referenced via complete module key. The metadata may not have been successfully retrieved
8
// due to timeouts on the provider so we always need to provide a default.
9
<div style="background-color: {$branch.metadata['example.plugin.branch.colors:color'] or '#cccccc'};">&nbsp;</div>
10
{/template}