Workflow file

Learn the structure of a workflow YAML file.

What is a workflow file?

GitHub Actions workflows are defined using YAML files located in the .github/workflows/ directory of a repository. Each file specifies the workflow name, the event that starts it, and the tasks it performs. These files commonly use the .yml or .yaml extension.

.github/
  workflows/
    tests.yml

The basic structure of a YAML file

YAML is a readable configuration format that uses indentation to create a hierarchy. In a workflow file, name defines the workflow name, on defines the starting event, and jobs defines the tasks to perform. Nested fields use spaces for indentation, which must remain consistent.

name: Test Workflow

on: push

jobs:
  test:
    runs-on: ubuntu-latest

Exercise Write your first workflow file

Complete the contents of tests.yml. Set the workflow name to Basic CI, set the triggering event to push, and configure a job named test to run on ubuntu-latest.

Show example solution

name: Basic CI

on: push

jobs:
  test:
    runs-on: ubuntu-latest

Test yourself

In which directory should a workflow YAML file be located?
- .github/workflows/
- public/workflows/
- .git/workflows/
- src/actions/
Show answer

.github/workflows/ — GitHub Actions workflow files are located in the .github/workflows directory at the repository root.

Define the workflow name

name: ____
on: push

jobs:
  test:
    runs-on: ubuntu-latest

Show answer

name: Test Workflow
on: push

jobs:
  test:
    runs-on: ubuntu-latest

Workflow fields

name

Workflow name
on

Triggering event
jobs

Tasks to perform
runs-on

Execution environment

Next lesson: Trigger

We Are Enhancing Your Experience

Cookie Preferences

Strictly Necessary Cookies

Analytical Cookies