> For the complete documentation index, see [llms.txt](https://notes.eliasnorrby.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://notes.eliasnorrby.com/github/github-actions-setup.md).

# Setting up GitHub Actions

To set up GitHub Actions in a project, all you need to do is place a valid workflow file within the `.github/workflows` directory. Here's an example (`.github/workflows/example.yaml`), running `yamllint` when a pull request is opened.

```yaml
name: example job

on: pull_request

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: yamllint
        run: yamllint .
```