Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/codacy/codacy-hadolint

Codacy Docker container for Hadolint tool
https://github.com/codacy/codacy-hadolint

badge codacy docker dockerfile hadolint haskell review scala

Last synced: 3 months ago
JSON representation

Codacy Docker container for Hadolint tool

Host: GitHub
URL: https://github.com/codacy/codacy-hadolint
Owner: codacy
Created: 2018-09-10T08:53:12.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-06-27T10:19:39.000Z (7 months ago)
Last Synced: 2024-06-27T15:03:22.899Z (7 months ago)
Topics: badge, codacy, docker, dockerfile, hadolint, haskell, review, scala
Language: Scala
Homepage:
Size: 220 KB
Stars: 1
Watchers: 15
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

# Codacy-Hadolint Docker Container

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/c5d062c19785439980803f4557f9e441)](https://www.codacy.com/gh/codacy/codacy-hadolint?utm_source=github.com&utm_medium=referral&utm_content=codacy/codacy-hadolint&utm_campaign=Badge_Grade)
[![Build Status](https://circleci.com/gh/codacy/codacy-hadolint.svg?style=shield&circle-token=:circle-token)](https://circleci.com/gh/codacy/codacy-hadolint)
[![Docker Version](https://images.microbadger.com/badges/version/codacy/codacy-hadolint.svg)](https://microbadger.com/images/codacy/codacy-hadolint "Get your own version badge on microbadger.com")

[Docker](https://www.docker.com) container to allow support for [Hadolint](https://github.com/hadolint/hadolint) on Codacy.

## Dockerfile building

To build the Codacy-Hadolint dockerfile :

1. Clone the source:

``` sh
$ git clone https://github.com/codacy/codacy-hadolint.git
$ cd codacy-hadolint
```

2. Build the container:

``` sh
$ docker build -t codacy-hadolint -f Dockerfile .
```

## Docs Generation

To update the Hadolint docs :

$ ./scripts/generate.sh

## Update version
1. Update `.tool_version`

## Docs

[Tool Developer Guide](https://support.codacy.com/hc/en-us/articles/207994725-Tool-Developer-Guide)

[Tool Developer Guide - Using Scala](https://support.codacy.com/hc/en-us/articles/207280379-Tool-Developer-Guide-Using-Scala)

## Test

We use the [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to test our external tools integration.
You can follow the instructions there to make sure your tool is working as expected.

## What is Codacy

[Codacy](https://www.codacy.com/) 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.