zola-check-manager

A Github Action allowing you to manage the zola check results in github
git clone git://archive.git.mtrnord.blog/MTRNord/zola-check-manager.git
Log | Files | Refs | README | LICENSE

README.md (1433B)

      1 # Zola Check Manager
      2 
      3 [![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2FMTRNord%2Fzola-check-manager%2Fbadge&style=flat)](https://actions-badge.atrox.dev/MTRNord/zola-check-manager/goto)
      4 ![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/MTRNord/zola-check-manager?sort=semver)
      5 
      6 A Github action to track the status of a `zola check` using check runs.
      7 
      8 ## Usage
      9 
     10 ```yaml
     11 name: Zola Check
     12 
     13 on:
     14   push:
     15     branches:
     16       - main
     17   pull_request:
     18     branches:
     19       - main
     20 
     21 jobs:
     22   zola-check:
     23     runs-on: ubuntu-latest
     24     steps:
     25       - uses: actions/checkout@v2
     26       - uses: MTRNord/zola-check-manager@v1
     27         with:
     28           repo-token: ${{ secrets.GITHUB_TOKEN }}
     29 ```
     30 
     31 ## Inputs
     32 
     33 * `working_directory`: The folder where the `zola check` should be executed. Default: `.`
     34 * `repo-token`: The token to use to authenticate with Github. Default: `${{ secrets.GITHUB_TOKEN }}`. This requires the `checks:write` permission.
     35 * `conclusion_level`: The conclusion level to use. Can be `action_required`, `failure`, `neutral`, `success`. Default: `action_required`
     36 
     37 ## Commit Guideline
     38 
     39 Please use [conventional commits](https://www.conventionalcommits.org). You can use the pre-commit script to ensure you
     40 do use conventional commits by running `pre-commit install -t prepare-commit-msg -t commit-msg`
     41 after [installing pre-commit](https://pre-commit.com/#install).