You should use the checkout action any time your workflow will use the repository's code. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). steps: # The `uses` keyword specifies that this step will run `v4` of the `actions/checkout` action. Each item nested under this section is a separate action or shell script. For syntax examples using other runners, see "(/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)" runs-on: ubuntu-latest # Groups together all the steps that run in the `check-bats-version` job. This means that the job will execute on a fresh virtual machine hosted by GitHub. check-bats-version: # Configures the job to run on the latest version of an Ubuntu Linux runner. The child keys will define properties of the job. jobs: # Defines a job named `check-bats-version`. # Groups together all the jobs that run in the `learn-github-actions` workflow. This is triggered by a push to every branch for examples of syntax that runs only on pushes to specific branches, paths, or tags, see "(/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore)." on: This example uses the `push` event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request. Run-name: $ is learning GitHub Actions # Specifies the trigger for this workflow. github/workflows/ directory, create a new file called learn-github-actions.yml and add the following code. github/workflows/ directory to store your workflow files. In this workflow, GitHub Actions checks out the pushed code, installs the bats testing framework, and runs a basic command to output the bats version: bats -v. You can create an example workflow in your repository that automatically triggers a series of commands whenever code is pushed. Each workflow is stored as a separate YAML file in your code repository, in a directory named. GitHub Actions uses YAML syntax to define the workflow. For the full reference of the YAML syntax for authoring workflows, see " Workflow syntax for GitHub Actions." Create an example workflow Events that occur outside of GitHub and trigger a repository_dispatch event on GitHubįor 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.įor more information, see " Triggering a workflow", and for a full list of events, see " Events that trigger workflows." Workflow syntax.Events that occur in your workflow's repository.Workflow triggers are events that cause a workflow to run. Each step can either run a script that you define or run an action, which is a reusable extension that can simplify your workflow.įor more information on these basic components, see " Understanding GitHub Actions.".One or more jobs, each of which will execute on a runner machine and run a series of one or more steps.One or more events that will trigger the workflow.Workflow basicsĪ workflow must contain the following basic components: For example, you can have one workflow to build and test pull requests, another workflow to deploy your application every time a release is created, and still another workflow that adds a label every time someone opens a new issue. github/workflows directory in a repository, and a repository can have multiple workflows, each of which can perform a different set of tasks. 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. A workflow is a configurable automated process that will run one or more jobs.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |