Skip to content

A Github Action allowing you to manage the zola check results in github

License

Notifications You must be signed in to change notification settings

MTRNord/zola-check-manager

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Zola Check Manager

Build Status GitHub release (latest SemVer)

A Github action to track the status of a zola check using check runs.

Usage

name: Zola Check

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  zola-check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: MTRNord/zola-check-manager@v1
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

Inputs

  • working_directory: The folder where the zola check should be executed. Default: .
  • repo-token: The token to use to authenticate with Github. Default: ${{ secrets.GITHUB_TOKEN }}. This requires the checks:write permission.
  • conclusion_level: The conclusion level to use. Can be action_required, failure, neutral, success. Default: action_required

Commit Guideline

Please use conventional commits. You can use the pre-commit script to ensure you do use conventional commits by running pre-commit install -t prepare-commit-msg -t commit-msg after installing pre-commit.