Skip to content

Latest commit

 

History

History
executable file
·
65 lines (39 loc) · 2.28 KB

README.md

File metadata and controls

executable file
·
65 lines (39 loc) · 2.28 KB

Codacy Badge Build Status

Codacy ShellCheck

Create the docker: sbt docker:publishLocal

The docker is supposed to be run with the following command:

docker run -it -v $srcDir:/src  <DOCKER_NAME>:<DOCKER_VERSION>

and $srcDir must contain a valid .codacy.json configuration

Docs

Docker Docs

Scala Docker Template Docs

Test

Follow the instructions at codacy-plugins-test

Generating the documentation

  1. Update the version tag in Dockerfile and run:
docker build -t codacy/alpine-jre-shellcheck -f Dockerfile .
  1. Update the VERSION variable in generate.sh and run:
cd docs
./generate.sh

This will create updated patterns.json, description.json and the individual documentation Markdown files.

What is Codacy?

Codacy is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.

Among Codacy’s features:

  • Identify new Static Analysis issues
  • Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
  • Auto-comments on Commits and Pull Requests
  • Integrations with Slack, HipChat, Jira, YouTrack
  • Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories

Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.

Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.

Free for Open Source

Codacy is free for Open Source projects.

License

Licensed under the Apache License, Version 2.0.