:rocket: Workflow syntax
Demo repository for basic GitHub Actions workflow syntax.
:exclamation: This is a template repository
- Please click Use this template to clone the repo into your user account or a different organization that you own, and run the demo from there
- If you're unable to use your personal account or a different organization, feel free to use this one. Just make sure to complete the Cleanup steps afterwards :house_with_garden:
Usage
Creating a workflow
- Click on the Actions tab
- If there are already existing workflows, click New workflow to navigate to the Starter workflow overview
- Select the Simple workflow
- Walk through the syntax (events, jobs, runner, steps, ...)
- Give the workflow a distinct file name and workflow
name
- Commit the workflow into a new branch and create the PR
Workflow logs and other features
- Observe the PR view which should show the workflow triggering (as long as the
pull_request
event was not removed from the workflow)
- Show the Checks tab inside the PR, which should show the workflow log
- Once the workflow has completed, merge the PR and delete the branch
- Click on the Actions tab and click on the current workflow run
- Show the features and information available in the workflow run GUI
- Visualization, re-running workflows, downloading logs, searching, toggling time stamps, etc.
- In the log, expand the Set up job --> Virtual environment, and navigate to the Included software link to show the VM spec of the runner
- Show how to trigger the workflow manually (available as long as the
workflow_dispatch
event was not removed from the workflow)
- Show how to disable the workflow
:house_with_garden: Cleanup
- If the workflow was run in this repository, perform the following steps:
- Ensure PRs are closed/merged
- Ensure any new branches are deleted
- Delete the workflow and commit to the main branch