/annotate_runs

This repository shall simply provide an interface to add annotations to a github action run

Primary LanguageTypeScriptMIT LicenseMIT

typescript-action status

Annotate runs github action 🚀

This github action provides a very simple interface to add an annotation to a github run.

Inputs

All inputs are optional - if you don't add any, then the action will just do nothing!

You can add info, warn and error - the inputs are simple strings which will be routed to the github action output.

  • info : string
  • warning: string
  • error: string

Outputs

This github actions does not have any outputs, it just annotates ( or not :) )

Example usage

uses: mholetzko/annotate_runs@v1.0.0
with:
  info: 'This is an info'
  warning: 'This is a warning'
  error: 'This is an error'

Doing so, you will get the following output of your run. Keep in mind, that the heading of each annotation is equal to your pipeline step name. example step output

uses: mholetzko/annotate_runs@v1.0.0
with:
  title: 'Example Annotation Title'
  info: 'This is an info'
  warning: 'This is a warning'
  error: 'This is an error'

If you want you can also add a dedicated title example step output