docs/content/actions/quickstart.md

title, intro, allowTitleToDifferFromFilename, redirect_from, versions, type, topics, shortTitle

title	intro	allowTitleToDifferFromFilename	redirect_from	versions	type	topics	shortTitle
Quickstart for GitHub Actions	Try out the features of {% data variables.product.prodname_actions %} in 5 minutes or less.	true	/actions/getting-started-with-github-actions/starting-with-preconfigured-workflow-templates	fpt ghes ghae ghec * * * *	quick_start	Fundamentals	Quickstart

{% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %}

Introduction

You only need a {% data variables.product.prodname_dotcom %} repository to create and run a {% data variables.product.prodname_actions %} workflow. In this guide, you'll add a workflow that demonstrates some of the essential features of {% data variables.product.prodname_actions %}.

The following example shows you how {% data variables.product.prodname_actions %} jobs can be automatically triggered, where they run, and how they can interact with the code in your repository.

Creating your first workflow

1. Create a .github/workflows directory in your repository on {% data variables.product.prodname_dotcom %} if this directory does not already exist.

2. In the .github/workflows directory, create a file named github-actions-demo.yml. For more information, see "AUTOTITLE."

3. Copy the following YAML contents into the github-actions-demo.yml file:

   name: GitHub Actions Demo
   {%- ifversion actions-run-name %}
   run-name: {% raw %}${{ github.actor }}{% endraw %} is testing out GitHub Actions 🚀
   {%- endif %}
   on: [push]
   jobs:
     Explore-GitHub-Actions:
       runs-on: ubuntu-latest
       steps:
         - run: echo "🎉 The job was automatically triggered by a {% raw %}${{ github.event_name }}{% endraw %} event."
         - run: echo "🐧 This job is now running on a {% raw %}${{ runner.os }}{% endraw %} server hosted by GitHub!"
         - run: echo "🔎 The name of your branch is {% raw %}${{ github.ref }}{% endraw %} and your repository is {% raw %}${{ github.repository }}{% endraw %}."
         - name: Check out repository code
           uses: {% data reusables.actions.action-checkout %}
         - run: echo "💡 The {% raw %}${{ github.repository }}{% endraw %} repository has been cloned to the runner."
         - run: echo "🖥️ The workflow is now ready to test your code on the runner."
         - name: List files in the repository
           run: |
             ls {% raw %}${{ github.workspace }}{% endraw %}
         - run: echo "🍏 This job's status is {% raw %}${{ job.status }}{% endraw %}."
   

4. Scroll to the bottom of the page and select Create a new branch for this commit and start a pull request. Then, to create a pull request, click Propose new file.

   

Committing the workflow file to a branch in your repository triggers the push event and runs your workflow.

Viewing your workflow results

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %}

1. In the left sidebar, click the workflow you want to display, in this example "GitHub Actions Demo."

   

2. From the list of workflow runs, click the name of the run you want to see, in this example "USERNAME is testing out GitHub Actions."

3. In the left sidebar of the workflow run page, under Jobs, click the Explore-GitHub-Actions job.

   

4. The log shows you how each of the steps was processed. Expand any of the steps to view its details.

   

   For example, you can see the list of files in your repository:

The example workflow you just added is triggered each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. For an in-depth tutorial, see "AUTOTITLE."

More starter workflows

{% data reusables.actions.workflow-template-overview %}

Next steps

{% data reusables.actions.onboarding-next-steps %}