Get a high-level overview of GitHub Actions workflows, including triggers, syntax, and advanced features.
About workflowsA workflow is a configurable automated process that will run one or more jobs. Workflows are defined by a YAML file checked in to your repository and will run when triggered by an event in your repository, or they can be triggered manually, or at a defined schedule.
Workflows are defined in the .github/workflows
directory in a repository. A repository can have multiple workflows, each of which can perform a different set of tasks such as:
A workflow must contain the following basic components:
For more information on these basic components, see Understanding GitHub Actions.
Workflow triggersWorkflow triggers are events that cause a workflow to run. These events can be:
repository_dispatch
event on GitHubFor example, you can configure your workflow to run when a push is made to the default branch of your repository, when a release is created, or when an issue is opened.
Workflow triggers are defined with the on
key. For more information, see Workflow syntax for GitHub Actions.
The following steps occur to trigger a workflow run:
.github/workflows
directory in the root of your repository for workflow files that are present in the associated commit SHA or Git ref of the event.on:
values that match the triggering event. Some events also require the workflow file to be present on the default branch of the repository in order to run.Each workflow run will use the version of the workflow that is present in the associated commit SHA or Git ref of the event. When a workflow runs, GitHub sets the GITHUB_SHA
(commit SHA) and GITHUB_REF
(Git ref) environment variables in the runner environment. For more information, see Store information in variables.
For more information, see Triggering a workflow.
Next stepsTo build your first workflow, see Creating an example workflow.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4