Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gitblit-org/gitblit-flowdock-plugin

Integrate Gitblit with your FlowDock team
https://github.com/gitblit-org/gitblit-flowdock-plugin

Last synced: 7 days ago
JSON representation

Integrate Gitblit with your FlowDock team

Awesome Lists containing this project

README 

        
## Gitblit FlowDock plugin



*REQUIRES 1.5.0*



The Gitblit FlowDock plugin provides realtime integration for your FlowDock team.  The plugin inject events into a flow for branch or tag changes and ticket changes.



![example](example.png "Example integration")



### Installation



This plugin is referenced in the Gitblit Plugin Registry and you may install it using SSH with an administrator account.



    ssh host plugin refresh

    ssh host plugin install flowdock

    ssh host plugin ls



Alternatively, you can download the zip from [here](http://plugins.gitblit.com) manually copy it to your `${baseFolder}/plugins` directory.



### Setup



At a bare minimum you'll need one setting configured in `gitblit.properties`.



    flowdock.defaultToken = aToken



If you have the `powertools` plugin installed, you may configure this over SSH:



    ssh host gb config flowdock.defaultToken aToken



There a handful of additional optional settings:



    flowdock.fixedCommitTags =

    flowdock.fixedTicketTags =

    flowdock.useProjectFlows = false

    flowdock.postPersonalRepos = false

    flowdock.postTickets = true

    flowdock.postTicketComments = true

    flowdock.postBranches = true

    flowdock.postTags = true

    flowdock.ticketPayloadGenerator = com.gitblit.plugin.flowdock.TicketEmailGenerator



#### flowdock.fixedCommitTags



A list of tags to always attach to commit notifications.




flowdock.fixedCommitTags = git




#### flowdock.fixedTicketTags



A list of tags to always attach to ticket notifications.




flowdock.fixedTicketTags = ticket




#### flowdock.useProjectFlows



*flowdock.useProjectFlows* allows you to shard Gitblit activity by the repository project.  This may fit better with any security model you may have in place.  These flows *must* already exist in FlowDock, the plugin will not create them for you.




flowdock.defaultToken = aToken

flowdock.useProjectFlows = true

flowdock.network.token = 12345




- For the *network/a/b/myrepo.git* repository, the flow would be *network*.

- For the *test.git* repository, the flow would be the default flow.



#### flowdock.ticketPayloadGenerator



By default, the Gitblit-Flowdock plugin will generate standard Gitblit ticket email notifications and inject that into your flow using the Flowdock PUSH API.



There are two other *experimental* payload generators available.



- com.gitblit.plugin.flowdock.TicketJiraGenerator



The *JIRA* generator will format Gitblit Tickets as JIRA issues and use Flowdock's JIRA endpoint.



- com.gitblit.plugin.flowdock.TicketMessageGenerator



The *Message* generator will custom format Gitblit Tickets in a way similar to the default *Email* generator.



### Usage



#### Ticket Hook



The ticket hook is automatic.



#### Receive Hook



The receive hook is automatic.



#### SSH Commands (optional)



This plugin also provides a generic mechanism to inject messages into a FlowDock flow.  These commands require administrator permissions.



    ssh host flowdock test

    ssh host flowdock send flow -m "'this is a test'"



### Building against a Gitblit RELEASE



    ant && cp build/target/flowdock*.zip /path/to/gitblit/plugins



### Building against a Gitblit SNAPSHOT



    /path/to/dev/gitblit/ant installMoxie

    /path/to/dev/flowdock/ant && cp build/target/flowdock*.zip /path/to/gitblit/plugins