Quickstart for GitHub Actions

Introduction

GitHub Actions es una plataforma de integración y despliegue continuos (IC/DC) que te permite automatizar tu mapa de compilación, pruebas y despliegue. You can create workflows that run tests whenever you push a change to your repository, or that deploy merged pull requests to production.

This quickstart guide shows you how to use the user interface of GitHub to add a workflow that demonstrates some of the essential features of GitHub Actions.

Para empezar a trabajar con flujos de trabajo preconfigurados, examine la lista de plantillas del repositorio actions/starter-workflows. Para más información, consulta Uso de plantillas de flujo de trabajo.

For an overview of GitHub Actions workflows, see Acerca de los flujos de trabajo. If you want to learn about the various components that make up GitHub Actions, see Understanding GitHub Actions.

Using workflow templates

GitHub proporciona plantillas de flujo de trabajo preconfiguradas que puedes usar tal cual o bien personalizar para crear un flujo de trabajo propio. GitHub analiza el código y muestra plantillas de flujo de trabajo que podrían ser útiles para el repositorio. Por ejemplo, si tu repositorio contiene un código Node.js, verás sugerencias para los proyectos de Node.js.

Estas plantillas de flujo de trabajo están diseñadas para ayudarle a ponerse en marcha rápidamente, y ofrecen una variedad de configuraciones como las siguientes:

• CI: flujos de trabajo de integración continua
• Implementaciones: flujos de trabajo de implementación
• Automatización: flujos de trabajo de Automatización
• Examen de código: flujos de trabajo de examen de código
• Páginas: flujos de trabajo de páginas

Puede utilizar plantillas de flujo de trabajo como punto de partida para crear el flujo de trabajo personalizado, o bien utilizarlas tal cual. Puede examinar la lista completa de plantillas de flujo de trabajo en el repositorio actions/starter-workflows.

Prerequisites

This guide assumes that:

• You have at least a basic knowledge of how to use GitHub. If you don't, you'll find it helpful to read some of the articles in the documentation for repositories and pull requests first. For example, see Inicio rápido para repositorios, Acerca de las ramas, and Acerca de las solicitudes de incorporación de cambios.

• You have a repository on GitHub where you can add files.

• You have access to GitHub Actions.

  Nota:

  If the Actions tab is not displayed under the name of your repository on GitHub, it may be because Actions is disabled for the repository. For more information, see Administrar los ajustes de las GitHub Actions de un repositorio.

Creating your first workflow

1. In your repository on GitHub, create a workflow file called github-actions-demo.yml in the .github/workflows directory. To do this:

   • If the .github/workflows directory already exists, navigate to that directory on GitHub, click Add file, then click Create new file, and name the file github-actions-demo.yml.

   • If your repository doesn't have a .github/workflows directory, go to the main page of the repository on GitHub, click Add file, then click Create new file, and name the file .github/workflows/github-actions-demo.yml. This creates the .github and workflows directories and the github-actions-demo.yml file in a single step.

   Nota:

   For GitHub to discover any GitHub Actions workflows in your repository, you must save the workflow files in a directory called .github/workflows.

   You can give the workflow file any name you like, but you must use .yml or .yaml as the file name extension. YAML is a markup language that's commonly used for configuration files.

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

   YAML

   name: GitHub Actions Demo
   run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
   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@v4
         - 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 }}."
   

   At this stage you don't need to understand the details of this workflow. For now, you can just copy and paste the contents into the file. After completing this quickstart guide, you can learn about the syntax of workflow files in Acerca de los flujos de trabajo, and for an explanation of GitHub Actions contexts, such as ${{ github.actor }} and ${{ github.event_name }}, see Contexts reference.

3. Click Commit changes.

4. In the "Propose changes" dialog, select either the option to commit to the default branch or the option to create a new branch and start a pull request. Then click Commit changes or Propose changes.

   

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

If you chose to start a pull request, you can continue and create the pull request, but this is not necessary for the purposes of this quickstart because the commit has still been made to a branch and will trigger the new workflow.

Viewing your workflow results

1. En GitHub, navegue hasta la página principal del repositorio.

2. En el nombre del repositorio, haz clic en Acciones.

   

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

   

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

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

   

6. 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 GitHub Actions can work with the contents of your repository. For an in-depth tutorial, see Understanding GitHub Actions.

Next steps

GitHub Actions puede ayudarte a automatizar casi cualquier aspecto de tus procesos de desarrollo de aplicaciones. ¿Ya está listo para comenzar? Aquí tienes algunos recursos útiles para que tomes tus siguientes pasos con GitHub Actions:

• Para crear un flujo de trabajo de GitHub Actions, vea Uso de plantillas de flujo de trabajo.
• Para obtener flujos de trabajo de integración continua (CI), vea Compilación y prueba.
• Para compilar y publicar paquetes, consulte Publicar paquetes.
• Para implementar proyectos, consulte Casos de uso y ejemplos.
• Para automatizar tareas y procesos en GitHub, consulte Administrar proyectos.
• Para obtener ejemplos que demuestran características más complejas de GitHub Actions, vea Casos de uso y ejemplos. En estos ejemplos detallados se explica cómo probar el código en un ejecutor, acceder a la CLI de GitHub y usar características avanzadas, como la simultaneidad y las matrices de prueba.