Compilación y prueba de Go

Introducción

Esta guía te muestra cómo compilar, probar y publicar un paquete de Go.

Los ejecutores hospedados en GitHub tienen un caché de herramientas con software pre-instalado, que incluye las dependencias para Go. Para obtener una lista completa de software actualizado y las versiones preinstaladas de Go, consulta "Utilizar los ejecutores hospedados en GitHub".

Requisitos previos

Ya debes estar familiarizado con la sintaxis de YAML y con cómo se utiliza con GitHub Actions. Para obtener más información, vea «Sintaxis del flujo de trabajo para Acciones de GitHub».

Te recomendamos que tengas un entendimiento básico del lenguaje Go. Para más información, ve Introducción a Go.

Uso de una plantilla de flujo de trabajo de Go

Para comenzar rápidamente, agregue una plantilla de flujo de trabajo al directorio .github/workflows del repositorio.

GitHub proporciona una plantilla de flujo de trabajo de Go que debería funcionar para la mayoría de los proyectos de Go. En las secciones siguientes de esta guía se proporcionan ejemplos de cómo puede personalizar esta plantilla de flujo de trabajo.

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

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

   

3. Si ya tiene un flujo de trabajo en su repositorio, haga clic en New workflow (Nuevo flujo de trabajo).

4. En la página "Elegir un flujo de trabajo" se muestra una selección de plantillas de flujo de trabajo recomendadas. Busca «Go».

5. Filtra la selección de flujos de trabajo con un clic en Integración continua.

6. En el flujo de trabajo "Go - by GitHub Actions", haz clic en Configurar.

   
   Si no encuentra la plantilla de flujo de trabajo "Go, mediante GitHub Actions", copie el siguiente código de flujo de trabajo en un nuevo archivo llamado go.yml en el directorio .github/workflows del repositorio.
   YAML

   name: Go
   
   on:
     push:
       branches: [ "main" ]
     pull_request:
       branches: [ "main" ]
   
   jobs:
     build:
   
       runs-on: self-hosted
       steps:
         - uses: actions/checkout@v4
   
         - name: Set up Go
           uses: actions/setup-go@v5
           with:
             go-version: '1.20'
   
         - name: Build
           run: go build -v ./...
   
         - name: Test
           run: go test -v ./...
   

7. Edita el flujo de trabajo según sea necesario. Por ejemplo, cambia la versión de Go.

8. Haga clic en Commit changes (Confirmar cambios).

Especificación de una versión de Go

La forma más fácil de especificar una versión de Go consiste en usar la acción setup-go proporcionada por GitHub. Para obtener más información, consulta la acciónsetup-go.

Para usar una versión preinstalada de Go en un ejecutor hospedado por GitHub, pasa la versión pertinente a la propiedad go-version de la acción setup-go. Esta acción busca una versión específica de Go en la caché de herramientas en cada ejecutor y agrega los binarios necesarios a PATH. Estos cambios persistirán para el recordatorio del job.

La acción setup-go es la forma recomendada de usar Go con GitHub Actions, ya que ayuda a garantizar el comportamiento coherente entre los distintos ejecutores y versiones de Go. Si vas a usar un ejecutor auto hospedado, tienes que instalar Go y agregarlo a PATH.

Uso de varias versiones de Go

name: Go

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        go-version: [ '1.19', '1.20', '1.21.x' ]

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go ${{ matrix.go-version }}
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}
      # You can test your matrix by printing the current Go version
      - name: Display Go version
        run: go version

name: Go

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        go-version: [ '1.19', '1.20', '1.21.x' ]

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go ${{ matrix.go-version }}
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}
      # You can test your matrix by printing the current Go version
      - name: Display Go version
        run: go version

Uso de una versión específica de Go

Puedes configurar el trabajo para que use una versión específica de Go, como 1.20.8. Como alternativa, puedes utilizar una sintaxis de versión semántica para obtener el último lanzamiento menor. Este ejemplo usa la versión de revisión más reciente de Go 1.21:

      - name: Setup Go 1.21.x
        uses: actions/setup-go@v5
        with:
          # Semantic version range syntax or exact version of Go
          go-version: '1.21.x'

      - name: Setup Go 1.21.x
        uses: actions/setup-go@v5
        with:
          # Semantic version range syntax or exact version of Go
          go-version: '1.21.x'

Instalación de dependencias

Puedes usar go get para instalar dependencias:

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.21.x'
      - name: Install dependencies
        run: |
          go get .
          go get example.com/octo-examplemodule
          go get example.com/octo-examplemodule@v1.3.4

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.21.x'
      - name: Install dependencies
        run: |
          go get .
          go get example.com/octo-examplemodule
          go get example.com/octo-examplemodule@v1.3.4

Almacenar dependencias en caché

Puedes almacenar en caché las dependencias y restaurarlas mediante la acción setup-go. De forma predeterminada, el almacenamiento en caché está habilitado al usar la acción setup-go.

La acción setup-go busca el archivo de dependencia, go.sum, en la raíz del repositorio y usa el hash del archivo de dependencia como parte de la clave de caché.

Puede susar el parámetro cache-dependency-path para los casos en los que se usan varios archivos de dependencia o cuando se encuentran en distintos subdirectorios.

      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.17'
          cache-dependency-path: subdir/go.sum

      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.17'
          cache-dependency-path: subdir/go.sum

Si tiene una necesidad específica o necesita controles más precisos para el almacenamiento en caché, puede usar la acción cache. Para obtener más información, vea «Almacenar en caché las dependencias para agilizar los flujos de trabajo».

Construir y probar tu código

Puedes usar los mismos comandos que usas de forma local para construir y probar tu código. En este flujo de trabajo de ejemplo se muestra cómo usar go build y go test en un trabajo:

name: Go
on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.21.x'
      - name: Install dependencies
        run: go get .
      - name: Build
        run: go build -v ./...
      - name: Test with the Go CLI
        run: go test

name: Go
on: [push]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: '1.21.x'
      - name: Install dependencies
        run: go get .
      - name: Build
        run: go build -v ./...
      - name: Test with the Go CLI
        run: go test

Empaquetar datos de flujo de trabajo como artefactos

Después de que se completa un flujo de trabajo, puedes cargar los artefactos que se den como resultado para su análisis. Por ejemplo, es posible que debas guardar los archivos de registro, los vaciados de memoria, los resultados de las pruebas o las capturas de pantalla. En el ejemplo siguiente se muestra cómo puede usar la acción upload-artifact para cargar los resultados de la prueba.

Para obtener más información, vea «Almacenamiento y uso compartido de datos desde un flujo de trabajo».

name: Upload Go test results

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        go-version: [ '1.19', '1.20', '1.21.x' ]

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}
      - name: Install dependencies
        run: go get .
      - name: Test with Go
        run: go test -json > TestResults-${{ matrix.go-version }}.json
      - name: Upload Go test results
        uses: actions/upload-artifact@v3
        with:
          name: Go-results-${{ matrix.go-version }}
          path: TestResults-${{ matrix.go-version }}.json

name: Upload Go test results

on: [push]

jobs:
  build:

    runs-on: ubuntu-latest
    strategy:
      matrix:
        go-version: [ '1.19', '1.20', '1.21.x' ]

    steps:
      - uses: actions/checkout@v4
      - name: Setup Go
        uses: actions/setup-go@v5
        with:
          go-version: ${{ matrix.go-version }}
      - name: Install dependencies
        run: go get .
      - name: Test with Go
        run: go test -json > TestResults-${{ matrix.go-version }}.json
      - name: Upload Go test results
        uses: actions/upload-artifact@v3
        with:
          name: Go-results-${{ matrix.go-version }}
          path: TestResults-${{ matrix.go-version }}.json