Usar Sheet Best desde GitHub Actions
Sheet Best es una API REST estándar. Cualquier flujo de GitHub Actions puede llamarla desde un paso run mediante curl (o cualquier cliente HTTP disponible en el ejecutor), sin una acción personalizada.
Antes de empezar
- Una conexión de Sheet Best. Consulta la guía rápida.
- Un repositorio de GitHub en el que puedas añadir o editar flujos de trabajo.
- Si la conexión está protegida, guarda la clave como secreto del repositorio (por ejemplo,
SHEETBEST_API_KEY). Consulta autenticación con clave de API.
Leer filas (GET)
name: Read sheet
on: workflow_dispatch
jobs:
read:
runs-on: ubuntu-latest
steps:
- name: Fetch rows
env:
SHEETBEST_API_KEY: ${{ secrets.SHEETBEST_API_KEY }}
run: |
curl -sS \
-H "X-Api-Key: $SHEETBEST_API_KEY" \
"https://api.sheetbest.com/sheets/<id>"
Elimina la línea -H "X-Api-Key: ..." si la conexión no está protegida. Para filtrar, añade una columna y un valor a la URL (por ejemplo, /Status/active); consulta filtrado y consultas.
Escribir filas (POST)
name: Append row
on:
push:
branches: [main]
jobs:
log:
runs-on: ubuntu-latest
steps:
- name: Append commit to sheet
env:
SHEETBEST_API_KEY: ${{ secrets.SHEETBEST_API_KEY }}
run: |
curl -sS -X POST \
-H "Content-Type: application/json" \
-H "X-Api-Key: $SHEETBEST_API_KEY" \
-d '{
"Commit": "${{ github.sha }}",
"Author": "${{ github.actor }}",
"Message": ${{ toJSON(github.event.head_commit.message) }}
}' \
"https://api.sheetbest.com/sheets/<id>"
El cuerpo puede ser un objeto o un array de objetos (una fila por elemento). Los nombres de los campos deben coincidir con las cabeceras de las columnas de la hoja.
Actualizar y eliminar filas
El mismo patrón funciona con -X PATCH, -X PUT y -X DELETE. Para seleccionar una fila concreta, incluye una coincidencia de columna en la URL, por ejemplo:
curl -X PATCH \
-H "Content-Type: application/json" \
-d '{ "Status": "done" }' \
"https://api.sheetbest.com/sheets/<id>/Id/42"
Consulta actualizar filas y eliminar filas.