ETH Compiler Design Tests Output Formatter

This action parses the output of the make test command and formats it as a GitHub Action markdown.

Inputs

make-output Required The path to the output of the make command

Outputs

markdown

The formatted markdown to use in the GitHub Action.

Example usage

# Define your make step as follows
- name: Run make
    id: maketest
    run: |
        eval $(opam env)
        make > make.out

# Then use the output formatter
- name: Create GitHub Action markdown
    uses: BattleRush/eth-compilerdesign-output-action@main
    with:
        make-output: make.out

SETUP

Makefile

Put a new Makefile in the root of your Compiler Design project with the following content

# Get all root folders to run the make in except the _build and llvm dirrectory
SUBDIRS := $(wildcard */.)
SUBDIRS := $(filter-out _build/.,$(SUBDIRS))
SUBDIRS := $(filter-out llvm/.,$(SUBDIRS))
# You can exclude folders you dont want to test here
#SUBDIRS := $(filter-out hw1/.,$(SUBDIRS))

MAKE := make test

all: $(SUBDIRS)
$(SUBDIRS):
	$(MAKE) -C $@;\

.PHONY: all $(SUBDIRS)

Your folder structure should look like this:

├─ .github/
│    ├─ workflows/
│        | makefile.yml (Content of this file is shown bellow in section Example makefile.yml)
├─ Project1/ (Each project contains their own Makefile which is called from the main one)
├─ Project2/ (same)
├─ Project3/ (same)
├─ Makefile <- (This file is the global mainfile from above)

Example makefile.yml

You can put this in the root folder (.github/workflows) of the project which will then be used to run the action on each push

name: Run Tests

on:
  push:
    branches: [ "main" ]
  pull_request:
    branches: [ "main" ]
  workflow_dispatch: # This enables the workflow to be manually run in the browser in the 'Actions' Tab

jobs:
  build:
    # One can also use ubuntu-18.04 however this is getting depricated by Jan 2023
    runs-on: ubuntu-20.04 #ubuntu-latest for 22.04 (22.04 wont work with LLVM 9 however)
        
    steps:
    - name: checkout repo
      uses: actions/checkout@v3
      
    - name: Cache Opam
      id: cache-ocaml
      uses: actions/cache@v3
      with:
        path: /home/runner/.opam
        key: ${{ runner.os }}-opam-4.13.1

    - name: Cache LLVM
      id: cache-llvm
      uses: actions/cache@v3
      with:
        path: ./llvm
        key: llvm-9
        
    - name: Install LLVM and Clang
      uses: KyleMayes/install-llvm-action@v1
      with:
        version: "9.0"
        cached: ${{ steps.cache-llvm.outputs.cache-hit }}

    - name: Set up OCaml
      uses: ocaml/[email protected]
      with:
        ocaml-version: 4.13.1

    # Change to opam environment after 4.13.1 switch and install needed packages
    - run: eval $(opam env)
    - run: opam install ocamlbuild
    - run: opam install menhir
    - run: opam install num 

    - name: Run make
      id: maketest
      run: |
        eval $(opam env)
        make > make.out
        
    - name: Create GitHub Action markdown
      id: outputparser
      uses: BattleRush/eth-compilerdesign-output-action@main
      with:
          make-output: make.out
          
    - name: Get the output markdown
      run: echo "${{ steps.outputparser.outputs.markdown }}" >> $GITHUB_STEP_SUMMARY

.gitignore (Recommended)

To prevent any build errors, its recommended to not push any build binaries. For this reason create a .gitignore file in your root directory with the following content

.cmo
.o
.cmi
.cmx

_build
.gitignore
output

.vscode

main.native
main.byte

Example output