Extension Pack for an Atomist SDM to integrate Checkstyle
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.atomist/hooks
legal
lib
test
.gitattributes
.gitignore
.npmignore
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
index.ts
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

@atomist/sdm-pack-checkstyle

atomist sdm goals npm version

This Extension Pack for an Atomist SDM integrates Checkstyle, a static analysis tool for Java.

API doc

Usage

  1. First install the dependency in your SDM project
$ npm install @atomist/sdm-pack-checkstyle
  1. Install the support
import { checkstyleSupport } from "@atomist/sdm-pack-checkstyle";

sdm.addExtensionPack(checkstyleSupport({
    enabled: true,
    checkstylePath: "<path to a downloaded checkstyle-VERSION-all.jar>",    
}));

Support

General support questions should be discussed in the #support channel on our community Slack team at atomist-community.slack.com.

If you find a problem, please create an issue.

Development

You will need to install [node][] to build and test this project.

To run tests, define a GITHUB_TOKEN to any valid token that has repo access. The tests will create and delete repositories.

Define GITHUB_VISIBILITY=public if you want these to be public; default is private. You'll get a 422 response from repo creation if you don't pay for private repos.

Build and Test

Command Reason
npm install install all the required packages
npm run build lint, compile, and test
npm run lint run tslint against the TypeScript
npm run compile compile all TypeScript into JavaScript
npm test run tests and ensure everything is working
npm run clean remove stray compiled JavaScript files and build directory

Release

To create a new release of the project, update the version in package.json and then push a tag for the version. The version must be of the form M.N.P where M, N, and P are integers that form the next appropriate semantic version for release. The version in the package.json must be the same as the tag. For example:

$ npm version 1.2.3
$ git tag -a -m 'The ABC release' 1.2.3
$ git push origin 1.2.3

The Travis CI build (see badge at the top of this page) will publish the NPM module and automatically create a GitHub release using the tag name for the release and the comment provided on the annotated tag as the contents of the release notes.


Created by Atomist. Need Help? Join our Slack team.