Outline of some workflow checkpoints

[grantmacken]

Outline of some actual and possible workflow checkpoints

Smoke checks: push to a branch other than main provide checks for new features introduced on
A check should be done on a running instance of the production release tar produced by rebar3
A check failure aborts the run

PR review checks: on pull request , prior to build

• formatting: check if code formatted rebar3 fmt --check
• style guide: Elvis, the Erlang style reviewer
  maybe with run-elvis-with-reviewdog
• dialyzer: after build. cache plt dialyzer --format short --ignore-exit-status
  As part of the automated review process the a PR review check failure should not immediately abort the run

Release Benchmark Tests: a manual run which triggers **on workflow-dispatch" ** targets.
These are before - after release benchmarks to compare the performance of this release compared to the performance of the previous release. e.g. if the yaccety introduced in this release performs better that what was in a previous release then the benchmark tests should be proof of this.

• http: responses: ab and tsung
• app processes: flamegraph

each of these could be invoked with the gh ci client

 gh workflow run {name of workflow dispatch}

Unit Tests: a manual run which triggers **on workflow-dispatch" **
You wouldn't want to run 30,895 test cases on every push
however they could be run run on gh actions through a manual trigger
which produces a download artefact

ref notes
https://github.com/volkodavs/tsung-performance
https://hashrocket.com/blog/posts/build-the-ultimate-elixir-ci-with-github-actions