CredoJenkins

Reads a credo report in a json format (mix credo --strict --format json > credo.json) and transforms it into a format that Jenkins can natively understand.

As seen in: https://github.com/jenkinsci/warnings-ng-plugin/blob/master/plugin/src/test/resources/io/jenkins/plugins/analysis/warnings/steps/json-issues.log

Local Development

Running Docker Locally

You can run the whole environment in a docker container.

• Pro Tip: You can use VSCode's "Attach to a Running Container" feature, to develop from within the container.

Usage example:

# Build and run via
./scripts/run-docker.sh
docker exec -ti credo_jenkins sh

mix test
mix credo --strict
mix docs

Releases

We tag our releases with semver in mind.

git tag -a 0.1.1 -m "version 0.1.1"
git push origin --tags

Since it is not available in Hex, the package can be installed by adding credo_jenkins to your list of dependencies in mix.exs:

def deps do
  [
    {:credo_jenkins,
       git: "https://github.com/vitalbeats/credo_jenkins.git",
       tag: "0.1.0",
       only: [:dev, :test],
       runtime: false}
  ]
end