> For the complete documentation index, see [llms.txt](https://calnix.gitbook.io/eth-dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://calnix.gitbook.io/eth-dev/yield-mentorship-2022/github-actions.md).

# Github Actions

## Events

#### An event is a trigger for workflow

A common event that occurs on a repo, is when someone pushes code.

![test.yml](https://1628544884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTgomzlmn9NrxUY0OQ3cD%2Fuploads%2F8jCmjkiHoNX5rQNvuPqx%2Fimage.png?alt=media\&token=8fee7690-5b1e-44c2-b398-9ab158ae2e03)

* on: push
  * We specify the workflow to trigger when someone pushes new code.
  * This will run all the jobs within the workflow.
  * There are other triggers: <https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows>

## Jobs&#x20;

![](https://1628544884-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FTgomzlmn9NrxUY0OQ3cD%2Fuploads%2Fky90nlNjhrMLR2OwSorJ%2Fimage.png?alt=media\&token=c04d0628-a6d5-4ad3-99b6-d6001473d640)

* In this workflow we have a single named, **super-lint**
* It specifies multiple **steps** and **actions**

**Under steps, there are 2 actions being run.**&#x20;

1. **First it is going to checkout our code with checkout\@v2**
2. **Then its going to run the super-linter\@v3 against it**

{% hint style="info" %}
runs-on: specifies a container environment for the code to run within. By default Github runs this container for you - but you can host your own if you wish.

The default container options are: ubuntu, windows, macOS
{% endhint %}

Runners

Steps

actions