Quickstart for GitHub Actions

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

Create a .github/workflows directory in your repository on GitHub if this directory does not already exist.
In the .github/workflows directory, create a file named github-actions-demo.yml. For more information, see "Creating new files."

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 }}."

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

En your enterprise, vaya a la página principal del repositorio.
En el nombre del repositorio, haga clic en Acciones.
In the left sidebar, click the workflow you want to see.
From the list of workflow runs, click the name of the run you want to see.
Under Jobs , click the Explore-GitHub-Actions job.
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:

More starter workflows

GitHub Proporciona un flujo de trabajo preconfigurado que puedes personalizar para crear tu propio flujo de trabajo de integración contínua. GitHub AE analiza tu código y te muestra el flujo de trabajo inicial de IC que podría ser útil para tu repositorio. Por ejemplo, si tu repositorio contiene un código Node.js, verás sugerencias para los proyectos de Node.js. Puedes utilizar el flujo de trabajo inicial como un lugar para comenzar a crear tu flujo de trabajo personalizado o utilizarlo tal cual.

Puede examinar la lista completa del flujo de trabajo de inicio en el repositorio actions/starter-workflows en your enterprise.

More complex examples

Para ver ejemplos que demuestren características más complejas de GitHub Actions, consulta "Ejemplos". Para ver ejemplos detallados que explican cómo probar el código en un ejecutor, accede a la CLI de GitHub y usa características avanzadas, como la simultaneidad y las matrices de prueba.

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:

"Learn GitHub Actions" for an in-depth tutorial.