mirror of
https://github.com/hadolint/hadolint-action.git
synced 2024-08-16 10:09:53 +02:00
chore: update README and CI pipeline
This commit is contained in:
parent
7e374b112f
commit
37cdec0849
2 changed files with 51 additions and 52 deletions
68
.github/workflows/ci.yml
vendored
68
.github/workflows/ci.yml
vendored
|
@ -10,60 +10,34 @@ env:
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
lint:
|
lint:
|
||||||
runs-on: ubuntu-latest
|
name: Lint
|
||||||
container: pipelinecomponents/hadolint:latest
|
runs-on: ubuntu-20.04
|
||||||
|
container: pipelinecomponents/hadolint:0.10.1
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v2
|
||||||
- name: Run hadolint
|
- name: Run hadolint
|
||||||
run: hadolint Dockerfile
|
run: hadolint Dockerfile
|
||||||
|
|
||||||
build:
|
build-test:
|
||||||
runs-on: ubuntu-latest
|
name: Build and Test
|
||||||
needs: ['lint']
|
runs-on: ubuntu-20.04
|
||||||
|
needs: ["lint"]
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v2
|
||||||
- name: Build Docker image
|
- name: Build Docker image
|
||||||
run: docker build -t $TEST_IMAGE_NAME .
|
run: docker build -t $TEST_IMAGE_NAME .
|
||||||
|
|
||||||
- name: Save Docker image artifact
|
|
||||||
run: docker save -o action.tar $TEST_IMAGE_NAME
|
|
||||||
|
|
||||||
- name: Upload image artifact
|
|
||||||
uses: actions/upload-artifact@master
|
|
||||||
with:
|
|
||||||
name: action-image
|
|
||||||
path: action.tar
|
|
||||||
|
|
||||||
test:
|
|
||||||
name: Unit Tests
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
needs: build
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v1
|
|
||||||
|
|
||||||
- name: Pull Image artifact
|
|
||||||
uses: actions/download-artifact@master
|
|
||||||
with:
|
|
||||||
name: action-image
|
|
||||||
|
|
||||||
- name: Load image into docker context
|
|
||||||
run: docker load -i action.tar
|
|
||||||
|
|
||||||
- name: Get Image Name
|
|
||||||
id: image_name
|
|
||||||
run: echo "##[set-output name=image;]$(echo $TEST_IMAGE_NAME)"
|
|
||||||
|
|
||||||
- name: Run Structure tests
|
- name: Run Structure tests
|
||||||
uses: brpaz/structure-tests-action@master
|
uses: brpaz/structure-tests-action@v1.1.2
|
||||||
with:
|
with:
|
||||||
image: ${{ steps.image_name.outputs.image }}
|
image: ${{ env.TEST_IMAGE_NAME }}
|
||||||
|
|
||||||
integration:
|
integration-tests:
|
||||||
name: Integration Tests
|
name: Integration Tests
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-20.04
|
||||||
needs: test
|
needs: build-test
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v2
|
||||||
|
|
||||||
- name: Run integration test
|
- name: Run integration test
|
||||||
uses: ./
|
uses: ./
|
||||||
|
@ -73,11 +47,13 @@ jobs:
|
||||||
release:
|
release:
|
||||||
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
|
if: github.event_name == 'push' && github.ref == 'refs/heads/master'
|
||||||
name: Release
|
name: Release
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-20.04
|
||||||
needs: integration
|
needs: integration-tests
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v2
|
||||||
- name: Semantic Release
|
- uses: cycjimmy/semantic-release-action@v2
|
||||||
uses: brpaz/action-semantic-release@master
|
with:
|
||||||
|
extra_plugins: |
|
||||||
|
@semantic-release/git
|
||||||
env:
|
env:
|
||||||
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
|
||||||
|
|
35
README.md
35
README.md
|
@ -1,26 +1,35 @@
|
||||||
# Hadolint GitHub Action
|
# Hadolint Action
|
||||||
|
|
||||||
> Action that runs [Hadolint](https://github.com/hadolint/hadolint) Dockerfile linting tool.
|
> GitHub Action that runs [Hadolint](https://github.com/hadolint/hadolint) Dockerfile linting tool.
|
||||||
|
|
||||||
[![GitHub Action](https://img.shields.io/badge/GitHub-Action-blue?style=for-the-badge)](https://github.com/features/actions)
|
[![GitHub Action](https://img.shields.io/badge/GitHub-Action-blue?style=for-the-badge)](https://github.com/features/actions)
|
||||||
[![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](LICENSE)
|
[![License](https://img.shields.io/badge/License-MIT-yellow.svg?style=for-the-badge)](LICENSE)
|
||||||
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)
|
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge)](http://commitizen.github.io/cz-cli/)
|
||||||
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release?style=for-the-badge)
|
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release?style=for-the-badge)
|
||||||
|
|
||||||
[![GitHub Actions](https://github.com/brpaz/hadolint-action/workflows/CI/badge.svg?style=for-the-badge)](https://github.com/brpaz/hadolint-action/actions)
|
[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/brpaz/hadolint-action/CI?style=for-the-badge)](https://github.com/brpaz/hadolint-action/action)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
Add the following step to your workflow configuration:
|
||||||
|
|
||||||
```yml
|
```yml
|
||||||
steps:
|
steps:
|
||||||
uses: brpaz/hadolint-action@master
|
- uses: brpaz/hadolint-action@v1.2.1
|
||||||
|
with:
|
||||||
|
dockerfile: Dockerfile
|
||||||
```
|
```
|
||||||
|
|
||||||
## Inputs
|
## Inputs
|
||||||
|
|
||||||
**`dockerfile`**
|
| Name | Description | Default |
|
||||||
|
|------------ |----------------------------------------- |-------------- |
|
||||||
|
| dockerfile | The path to the Dockerfile to be tested | ./Dockerfile |
|
||||||
|
|
||||||
|
## Hadolint Configuration
|
||||||
|
|
||||||
|
To configure Hadolint (for example ignore rules), you can create an `.hadolint.yaml` file in the root of your repository. Please check the Hadolint [documentation](https://github.com/hadolint/hadolint#configure).
|
||||||
|
|
||||||
The path to the Dockerfile to be tested. By default it will look for a Dockerfile in the current directory.
|
|
||||||
|
|
||||||
## 🤝 Contributing
|
## 🤝 Contributing
|
||||||
|
|
||||||
|
@ -37,6 +46,20 @@ Contributions are what make the open source community such an amazing place to b
|
||||||
* [Building actions - GitHub Help](https://help.github.com/en/articles/building-actions)
|
* [Building actions - GitHub Help](https://help.github.com/en/articles/building-actions)
|
||||||
* [actions/toolkit: The GitHub ToolKit for developing GitHub Actions.](https://github.com/actions/toolkit)
|
* [actions/toolkit: The GitHub ToolKit for developing GitHub Actions.](https://github.com/actions/toolkit)
|
||||||
|
|
||||||
|
|
||||||
|
## 💛 Support the project
|
||||||
|
|
||||||
|
If this project was useful to you in some form, I would be glad to have your support. It will help to keep the project alive and to have more time to work on Open Source.
|
||||||
|
|
||||||
|
The sinplest form of support is to give a ⭐️ to this repo.
|
||||||
|
|
||||||
|
You can also contribute with [GitHub Sponsors](https://github.com/sponsors/brpaz).
|
||||||
|
|
||||||
|
[![GitHub Sponsors](https://img.shields.io/badge/GitHub%20Sponsors-Sponsor%20Me-red?style=for-the-badge)](https://github.com/sponsors/brpaz)
|
||||||
|
|
||||||
|
Or if you prefer a one time donation to the project, you can simple:
|
||||||
|
|
||||||
|
<a href="https://www.buymeacoffee.com/Z1Bu6asGV" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: auto !important;width: auto !important;" ></a>
|
||||||
## Author
|
## Author
|
||||||
|
|
||||||
👤 **Bruno Paz**
|
👤 **Bruno Paz**
|
||||||
|
|
Loading…
Reference in a new issue