GitHub es una plataforma web de desarrollo colaborativo que permite a los desarrolladores alojar, revisar y gestionar código fuente mediante el control de versiones Git. Su uso está muy extendido en proyectos de software privado y de código abierto, y permite la colaboración, el seguimiento de cambios y la integración continua.
Table of Contents
¿Qué es este módulo?
GitHub es una plataforma de desarrollo colaborativo basada en la web que permite a los desarrolladores alojar, revisar y gestionar código fuente utilizando control de versiones Git. Es ampliamente utilizada tanto para proyectos de código abierto como privados, y facilita la colaboración, el seguimiento de cambios y la integración continua. Este módulo permite interactuar con eventos de repositorios, pull requests, commits y más desde Saturn Studio.
¿Cómo obtener las credenciales? Haz clic aquí
Descripción de los comandos
Subscribe to webhook
Suscribirse a un webhook de GitHub. (No requiere parámetros adicionales configurables desde el módulo.)
Wait for an Event
Esperar un evento proveniente de un webhook de GitHub.
| Parámetro | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de GitHub necesaria para escuchar eventos de Pull Request. | credential |
| Evento | Evento de GitHub a esperar desde el webhook. | Select a GitHub event |
| Simplificar datos | Determina si se desea simplificar los datos recibidos en el mensaje. | (vacío o marcado) |
| Asignar resultado a variable | Variable donde se almacenará el resultado. Ejemplo: {“action”:”opened”,”number”:25,”pull_request”:{“url”:”https://api.github.com/repos/ExampleUser/repo/pulls/25″,”id”:1234567890,…},”repository”:{“id”:987654,”name”:”repo”,”full_name”:”ExampleUser/repo”},…} | {var} |
Get a Repository
Obtener información de un repositorio de GitHub.
| Parámetro | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de GitHub necesaria para obtener el repositorio. | credential |
| Owner | Usuario o propietario del repositorio. | JohnDoe |
| Nombre del Repositorio | Nombre del repositorio. | repository-name |
| Asignar resultado a variable | Variable donde se almacenará el resultado. Ejemplo: {“repository”:{“id”:987654321,”name”:”example-repo”,”full_name”:”ExampleUser/example-repo”,”owner”:{“login”:”ExampleUser”,”id”:123456789,…},”description”:”This is an example repository.”,…}} | {var} |
Get a Pull Request
Obtener información de un Pull Request específico.
| Parámetro | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de GitHub necesaria para obtener el Pull Request. | credential |
| Owner | Usuario o propietario del repositorio. | JohnDoe |
| Nombre del Repositorio | Nombre del repositorio. | repository-name |
| Pull Number | Número del Pull Request que se desea obtener. | 12331312 |
| Includes | Información adicional que se desea incluir (Commits, Files, Reviews, etc). | Commits, Files, Reviews, Status |
| Asignar resultado a variable | Variable donde se almacenará el resultado. Ejemplo: {“pull_request”:{“id”:9876543210,”number”:58,”title”:”Fix login issue”,”body”:”This pull request fixes the login issue…”,…}} | {var} |
List Commits
Listar los commits de un repositorio en GitHub.
| Parámetro | Descripción | Ejemplo |
|---|---|---|
| Credencial | Credencial de GitHub necesaria para listar los commits. | credential |
| Owner | Usuario o propietario del repositorio. | JohnDoe |
| Nombre del Repositorio | Nombre del repositorio. | repository-name |
| Asignar resultado a variable | Variable donde se almacenará el resultado. Ejemplo: {“commits”:[{“sha”:”5a4b6c7d8e9f0g1h2i3j4k5l6m7n8o9p0q1r2s3t”,”commit”:{“message”:”Add new feature for user authentication”,…}}]} | {var} |
Ejemplo de uso
Wait for an Event
Escuchar un evento tipo “pull_request” y capturar los datos en una variable.
Get a Repository
Obtener todos los datos del repositorio llamado repository-name del usuario JohnDoe.
Get a Pull Request
Obtener el Pull Request número 58 del repositorio repository-name, incluyendo los commits y archivos asociados.
List Commits
Listar los últimos commits del repositorio y almacenarlos en una variable.
Requisitos
- Tener una credencial válida de GitHub configurada en Saturn Studio.
- Tener permisos de acceso para consultar repositorios y eventos dentro de GitHub.
- Para esperar eventos mediante webhook, se debe tener configurado correctamente el enlace entre GitHub y Saturn Studio.