Skip to main content

Quickstart for GitHub Actions

Try out the features of GitHub Actions in 5 minutes or less.

Introduction

You only need a GitHub repository to create and run a GitHub Actions workflow. In this guide, you'll add a workflow that demonstrates some of the essential features of GitHub Actions.

The following example shows you how GitHub 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 GitHub 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 "Creating new files."

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

    YAML
    name: GitHub Actions Demo
    on: [push]
    jobs:
      Explore-GitHub-Actions:
        runs-on: ubuntu-latest
        steps:
          - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
          - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
          - run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
          - name: Check out repository code
            uses: actions/checkout@v2
          - run: echo "💡 The ${{ github.repository }} 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 ${{ github.workspace }}
          - run: echo "🍏 This job's status is ${{ job.status }}."
  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.

    Commit workflow file

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

Viewing your workflow results

  1. No your enterprise, navegue até a página principal do repositório.

  2. Abaixo do nome do repositório, clique em Actions. Guia Actions no menu de navegação do repositório principal

  3. In the left sidebar, click the workflow you want to see.

    Workflow list in left sidebar

  4. From the list of workflow runs, click the name of the run you want to see.

    Name of workflow run

  5. Under Jobs , click the Explore-GitHub-Actions job.

    Locate job

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

    Example workflow results

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

More starter workflows

O GitHub fornece um fluxo de trabalho inicial pré-configurado que você pode personalizar para criar seu fluxo de trabalho de integração contínua. O GitHub AE analisa seu código e mostra o fluxo de trabalho inicial de CI que pode ser útil para seu repositório. Por exemplo, se o seu repositório contiver o código Node.js, você verá sugestões para projetos Node.js. Você pode usar o fluxo de trabalho inicial como ponto de partida para criar seu fluxo de trabalho personalizado ou usá-lo no estado em que se encontra.

Navegue pela lista completa do fluxo de trabalho inicial no repositório actions/starter-workflows no your enterprise.

More complex examples

Para obter exemplos que demonstram recursos mais complexos do GitHub Actions, confira " Exemplos". Você pode ver exemplos detalhados que explicam como testar seu código em um executor, acessar a CLI do GitHub e usar recursos avançados, como simultaneidade e matrizes de teste.

Next steps

The example workflow you just added runs each time code is pushed to the branch, and shows you how GitHub Actions can work with the contents of your repository. But this is only the beginning of what you can do with GitHub Actions:

  • Your repository can contain multiple workflows that trigger different jobs based on different events.
  • You can use a workflow to install software testing apps and have them automatically test your code on GitHub's runners.

GitHub Actions can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with GitHub Actions: