DEV Community

loading...

Citellus GitHub Action

Pablo Iranzo Gómez
・1 min read

My Workflow

https://github.com/citellusorg/gh-action-citellus/ allows to run a custom set of rules against a folder and generate a GitHub site so that the report can be previewed online.

A new rule added triggers a new execution with new report rendering.

Submission Category:

Wacky Wildcards

Yaml File or Link to Code

GitHub logo citellusorg / gh-action-citellus

Runs Citellus as GitHub Action

GitHub Citellus Action

This action runs Citellus with provided parameters via optional build.sh and pushes the generated content to Git Hub Pages site.

Environment variables

  • GH_PAGES_BRANCH (optional): override the default gh-pages deployment branch
  • SOSREPORT (optional): override the default . folder for SOSREPORT source
  • CONFIGPATH (optional): Set path for finding the .citellus.conf configuration file

Setup

Create a .github/workflow/citellus.yml like:

name: Run Citellus analysis
on
  push
    branches:
      - master
  schedule:
    - cron: "0 0 * * *"

jobs:
  citellus:
    runs-on: ubuntu-16.04
    steps:
      - uses: actions/checkout@v2

      # Use GitHub Actions' cache to shorten build times and decrease load on servers
      - uses: actions/cache@v2.1.0
        with:
          path: ~/.cache/pip
          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements/*') }}
          restore-keys: |
            ${{ runner.os }}-pip-

      - uses: citellusorg/gh-action-citellus@0.0.1
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
          SOSREPORT: test
          CONFIGPATH: "./"
Enter fullscreen mode Exit fullscreen mode

Adjust…

Additional Resources / Info

Used at IPI Validations by @iranzo to use a custom set of scripts and config to generate validation output https://github.com/iranzo/ipival/

Sample output from that repository at: https://iranzo.github.io/ipival/

Discussion (0)

Forem Open with the Forem app