gha-timer

Time and group logs for GitHub actions

• Motivation
• Usage
  • Inputs
  • Outputs
• Command Line Tool
  • Quickstart
  • Recommended Installation
  • Installing into a mamba environment

Visit us at Fulcrum Genomics to learn more about how we can power your Bioinformatics with gha-timer and beyond.

Motivation

This GitHub action and associated command-line tool enable log grouping and printing of the elapsed time of that log group, with colored icons next to the elapsed based on the provided outcome (success, failure, cancelled, or skipped).

Usage

jobs:
  job:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: fulcrumgenomics/gha-timer@v1
      - id: example
        shell: bash
        run: |
          gha-timer start --name build
          ... do something
          gha-timer elapsed --name build

Inputs

- uses: fulcrumgenomics/gha-timer@v1
  with:
    # The color of the success outcome
    # Default: green
    success-color: ''

    # The icon to use for the success outcome
    # Default: ✓
    success-icon: ''

    # The color of the failure outcome
    # Default: red
    failure-color: ''

    # The icon to use for the failure outcome
    # Default: ✕
    failure-icon: ''

    # The color of the cancelled outcome
    # Default: yellow
    cancelled-color: ''

    # The icon to use for the cancelled outcome
    # Default: ✕
    cancelled-icon: ''

    # The color of the skipped outcome
    # Default: gray
    skipped-color: ''

    # The icon to use for the skipped outcome
    # Default: ✕
    skipped-icon: ''

    # Skip emitting the banner
    # Default: false
    skip-banner: ''

Outputs

There are currently no outputs

Command Line Tool

Quickstart

Install command line tool:

pip install gha-timer

Start a timer:

$ gha-timer start

Get the elapsed time:

$ gha-timer elapsed --outcome success
                                                                      ✓ 10.8s
$ gha-timer elapsed --outcome failure
                                                                      ✕ 20.2s
$ gha-timer elapsed --outcome cancelled
                                                                      ✕ 33.6s
$ gha-timer elapsed --outcome skipped  
                                                                      ✕ 37.3s

Stop the timer:

$ gha-timer stop

Use the --name option to add group log lines:

$ gha-timer start --name "Build the project"
::group::Build the project
$ gha-timer elapsed --outcome success --name "Build the project"
::endgroup::Build the project
                                                                      ✓ 19.2s

Specify a custom configuration file with --config (or just create a ~/.timerrc) to control the color and icon for each outcome (steps.<step_id>.outcome: success, failure, cancelled, or skipped). Below is the default configuration:

success:
  color: green
  icon: "✓"
failure:
  color: red
  icon: "✕"
cancelled:
  color: yellow
  icon: "✕"
skipped:
  color: gray
  icon: "✕"

Supported colors are: red, green, yellow, blue, cyan, bright_red, bright_green, white, gray, and bg_grey.

Recommended Installation

Install the Python package and dependency management tool poetry using official documentation. You must have Python 3.11 or greater available on your system path, which could be managed by mamba, pyenv, or another package manager. Finally, install the dependencies of the project with:

poetry install

To check successful installation, run:

gha-timer --help

Installing into a Mamba Environment

Install the Python package and dependency management tool poetry and the environment manager mamba using official documentation. Create and activate a virtual environment with Python 3.11 or greater:

mamba create -n gha_timer python=3.11
mamba activate gha_timer

Then, because Poetry will auto-detect an activated environment, install the project with:

poetry install

To check successful installation, run:

$ gha-timer start
$ gha-timer elapsed --outcome success
$ gha-timer stop

Development and Testing

See the contributing guide for more information.