README.md

GitHub Risu Action

This action runs Risu 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 .risu.conf configuration file

Setup

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

name: Run RISU analysis

on:
  push:
    branches:
      - master
  schedule:
    - cron: "0 0 * * *"

jobs:
  Risu:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

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

      - uses: risuorg/[email protected]
        env:
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
          SOSREPORT: test
          CONFIGPATH: "./"
          RUNFILE: "./build.sh"

Adjust your build.sh for additional commands:

#!/bin/bash
mkdir -p output
touch output/risu.html
ln -s risu.html output/index.html

Commit and let the GitHub Actions take care of it!