> 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](/files/RU57y14vjJxkw0RJBWQn)

* 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;

![](/files/2jGyoEFI8ngi95BjQIQ9)

* 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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://calnix.gitbook.io/eth-dev/yield-mentorship-2022/github-actions.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.