40ants / github-actions Goto Github PK

View Code? Open in Web Editor NEW

11.0 3.0 0.0 461 KB

A web app to render SVG badges with results of GitHub action run.

Home Page: https://github-actions.40ants.com/

Common Lisp 97.30% Shell 0.55% Dockerfile 2.14%

github github-pages github-actions badge-generator

github-actions's Introduction

Github Matrix

WARNING!

Because of Visa and Mastercard sanctions against Russua, I'm unable to pay for Heroku hosting anymore and soon server will stop working on the domain github-actions.40ants.com

Goals

This project's aim is to give all repositories tested by Github Actions a way to show the full build status.

Especially it is useful when tests are running under a "matrix" combinations.

Try it!

Go to the https://github-actions.40ants.com/, enter your library's URL and see get your image!

A Few Previews

Here is an example of the render, when matrix has only two variables: os and lisp implementation:

matrix:
  lisp:
    - sbcl-bin
    - ccl-bin
  os:
    - ubuntu-latest
    - macos-latest

And this is how more complex matrix is rendered:

matrix:
  os:
    - ubuntu-latest
    - macos-latest
  quicklisp-dist:
    - quicklisp
    - ultralisp
  lisp:
    - sbcl-bin
    - ccl-bin
    - ecl
    - abcl
    - allegro
    - clisp
    - cmucl

How to test locally

(ql:quickload :app)

(app/server:start 8081 :debug t)

TODO

Support more grid layout for workflows with multiple combinations.
Add a special webhook which will be able to add an image into the pull-requests. This image should be rendered in a special mode and compare pull's results with results of the main branch. Diffrencies should be highlighted. This will make visible for which matrix combinations a pull request makes fixes/breaks tests.

Known Issues

Badge generator does not work for jobs with custom names like:
```
test:
  name: ${{ matrix.lisp }} on ${{ matrix.os }}
  runs-on: ${{ matrix.os }}
  strategy:
    matrix:
      lisp: [sbcl-bin, ccl-bin]
      os: [ubuntu-latest]
```
This is because github's API does not returns a matrix state for a run and we have to parse run's name to extract matrix values. Name should have this form instead: test (sbcl-bin, ubuntu-latest).

github-actions's People

Contributors

Stargazers

Watchers

github-actions's Issues

Making a compact badge

It would be nice to be able to specify which variables to collapse and not show in the badge.

e.g here I'd rather not show build or python version, just plone-version.

Also the attribution could be much closer and perhaps on top so that if the badge is inline with other badges then they line up. or even better if the attribution was a tooltip (https://talk.commonmark.org/t/abbr-tags-tooltips-using-link-syntax/965)

how to filter github action matrices (matrix fails to render as well)

Badge NO FILTER

[![](http://github-actions.40ants.com/mgood7123/prebuilder/matrix.svg)](https://github.com/mgood7123/prebuilder/actions)

Badge FILTERED

[![](http://github-actions.40ants.com/mgood7123/prebuilder/matrix.svg?only=CMake.run-build.ubuntu-latest,CMake.run-build.macOS-latest,CMake.run-build.windows-latest)](https://github.com/mgood7123/prebuilder/actions)

why does this have Waiting For A Run even though the workflow has succeeded?

also why does the matrix fail to render?

cmake.yaml:

name: CMake

on:
  push:
    branches: [ main ]

concurrency:
  group: build
  cancel-in-progress: true

env:
  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
  BUILD_TYPE: Debug

jobs:
  build:
    runs-on: ${{ matrix.os }}
    permissions:
      contents: write
    strategy:
      fail-fast: false
      max-parallel: 1
      matrix:
        include:
        
        - os: ubuntu-latest
          extension: so

        - os: macOS-latest
          extension: dylib

        - os: windows-latest
          extension: dll

    defaults:
      run:
        shell: bash

    steps:
    - uses: actions/checkout@v2
    
# ommited

Add doc for displaying branch-specific badge

I wonder if this is a feature that you have implemented, but didn't announce in the readme file?

If I use the branch argument in the URL, this plugin can generate the badge for that specific branch. E.g.

https://github-actions.40ants.com/40ants/ci/matrix.svg?branch=support-asdf-version

Generates the badge:

Should it be added? PR can come immediately

https://github-actions.40ants.com/ is down

Step to reproduce :

Go to https://github-actions.40ants.com/ in any browser

browser	error
Firefox	`PR_END_OF_FILE_ERROR`
Google Chrome	`ERR_CONNECTION_CLOSED`

Expected behavior

The good old one 👍

Strategy / matrix / include should be processed

The following 2 strategy matrix are identical:

      matrix:
        scalaVersion: ["2.13.6", "2.13.7"]

equals

      matrix:
        include:
          - scalaVersion: "2.13.6"
          - scalaVersion: "2.13.7"

But only the first one can be parse successfully and generate the proper badge

The second produces multiple jobs in github actions, but as a badge they cannot be identified:

Is this a known limitation?

Source code license

Hi, would it be possible to add a LICENSE file?

Combine matrix runs to make compact badge

In the following case I want to just show the result of runs just one matrix variable (or maybe combinations?)
The fix in #2 seems to hint this is possible but I suspect this is really a different request that what the ?only= was supposed to achieve

The following doesn't work

https://github-actions.40ants.com/collective/collective.collectionfilter/matrix.svg?only=ci.build.PLONE-VERSION

Breaks when ordering of inclusions is different

e.g.

        python-version: ['2.7']
        plone-version: 
          - '4.1'
          - '4.3'
          - '5.0'
          - '5.1'
          - '5.2'
        include:
          - plone-version: 5.2
            python-version: 3.7
          - plone-version: 5.2
            python-version: 3.8

ends up looking like

The service works slower than before when it was hosted on Heroku

It takes a lot of time to load, and sometimes it just doesn't