https://github.com/tomasbjerre/violation-comments-to-bitbucket-server-lib

A library for commenting Bitbucket Server with violations from static code analyzer reports.
https://github.com/tomasbjerre/violation-comments-to-bitbucket-server-lib

bitbucket-server static-code-analysis

Last synced: 3 months ago
JSON representation

A library for commenting Bitbucket Server with violations from static code analyzer reports.

• Host: GitHub
• URL: https://github.com/tomasbjerre/violation-comments-to-bitbucket-server-lib
• Owner: tomasbjerre
• License: apache-2.0
• Created: 2016-07-26T09:13:30.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-01-27T08:19:12.000Z (about 1 year ago)
• Last Synced: 2024-01-27T09:21:33.549Z (about 1 year ago)
• Topics: bitbucket-server, static-code-analysis
• Language: Java
• Size: 423 KB
• Stars: 5
• Watchers: 3
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Violation Comments to Bitbucket Server Lib

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/se.bjurr.violations/violation-comments-to-bitbucket-server-lib/badge.svg)](https://maven-badges.herokuapp.com/maven-central/se.bjurr.violations/violation-comments-to-bitbucket-server-lib)

This is a library that adds violation comments from static code analysis to Bitbucket Server.

It uses [Violation Comments Lib](https://github.com/tomasbjerre/violation-comments-lib) and supports the same formats as [Violations Lib](https://github.com/tomasbjerre/violations-lib).

 

Very easy to use with a nice builder pattern

```

  violationCommentsToBitbucketServerApi() //

    .withViolations(".*/findbugs/.*\\.xml$", FINDBUGS, rootFolder) //

    .withViolations(".*/checkstyle/.*\\.xml$", CHECKSTYLE, rootFolder) //

    .withUsername("username")

    .withPassword("password")

    .withProjectKey("projectKey")

    .withRepoSlug("repoSlug")

    .withPullRequestId("pullRequestId")

    .toPullRequest();

```

## Usage

This software can be used:

 * With a [Jenkins plugin](https://github.com/jenkinsci/violation-comments-to-stash-plugin).

 * From [Command Line](https://github.com/tomasbjerre/violation-comments-to-bitbucket-server-command-line)

### Properties

It can be configured with some Java properties:

 * `VIOLATIONS_KEYSTORE_PATH` - A path to a keystore.

 * `VIOLATIONS_KEYSTORE_PASS` - Password for the keystore. 

 * `VIOLATIONS_PAT` - Personal access token used to authenticate.

 * `VIOLATIONS_USERNAME` - Username to authenticate with.

 * `VIOLATIONS_PASSWORD` - Password to authenticate with.

## Developer instructions

To build the code, have a look at `.travis.yml`.

To do a release you need to do `./gradlew release` and release the artifact from [staging](https://oss.sonatype.org/#stagingRepositories). More information [here](http://central.sonatype.org/pages/releasing-the-deployment.html).