Introducción
En este tutorial se muestra cómo usar la acción actions/github-script
en un flujo de trabajo para etiquetar los problemas recientemente abiertos o vueltos a abrir. Por ejemplo, puede agregar la etiqueta triage
cada vez que se abre o se vuelve a abrir un problema. Después, puede ver todas los problemas que necesitan clasificarse filtrando los problemas con la etiqueta triage
.
La acción actions/github-script
permite usar fácilmente la API GitHub en un flujo de trabajo.
En el tutorial, primero creará un archivo de flujo de trabajo en el que se usa la acción actions/github-script
. Después, personalizarás el flujo de trabajo de acuerdo con tus necesidades.
Crear un flujo de trabajo
-
Elige un repoisitorio en donde quieras aplicar este fluljo de trabajo de administración de proyectos. Puedes utilizar un repositorio existente al cual tengas acceso de escritura o puedes crear un repositorio nuevo. Para más información sobre cómo crear un repositorio, consulta "Crear un repositorio nuevo".
-
En el repositorio, cree un archivo denominado
.github/workflows/YOUR_WORKFLOW.yml
, y reemplaceYOUR_WORKFLOW
por el nombre que prefiera. Este es un archivo de flujo de trabajo. Para obtener más información sobre cómo crear nuevos archivos en GitHub, consulte "Crear nuevos archivos". -
Copia el siguiente contenido de YAML en tu archivo de flujo de trabajo.
YAML name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - uses: actions/github-script@v6 with: script: | github.rest.issues.addLabels({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, labels: ["triage"] })
name: Label issues on: issues: types: - reopened - opened jobs: label_issues: runs-on: ubuntu-latest permissions: issues: write steps: - uses: actions/github-script@v6 with: script: | github.rest.issues.addLabels({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, labels: ["triage"] })
-
Personaliza el parámetro
script
en tu archivo de flujo de trabajo:- Los valores
issue_number
,owner
yrepo
se establecen automáticamente mediante el objetocontext
. Normalmente no es necesario cambiar estos valores. - Cambie el valor de
labels
a la lista de etiquetas que quiera agregar al problema. Separa las etiquetas con comas. Por ejemplo,["help wanted", "good first issue"]
. Para más información sobre las etiquetas, consulta "Administrar las etiquetas".
- Los valores
-
Confirma tu archivo de flujo de trabajo en la rama predeterminada de tu repositorio. Para obtener más información, vea «Crear nuevos archivos».
Prueba el flujo de trabajo
Cada que se abre o re-abre una propuesta en tu repositorio, este flujo de trabajo agregará a la propuesta las etiquetas que especificaste.
Prueba tu flujo de trabajo creando una propuesta en tu repositorio.
- Crea una propuesta en tu repositorio. Para obtener más información, vea «Crear una propuesta».
- Para ver la ejecución de flujo de trabajo que se activó al crear la propuesta, ve el historial de tus ejecuciones de flujo de trabajo. Para obtener más información, vea «Visualizar el historial de ejecución del flujo de trabajo».
- Cuando se complete el flujo de trabajo, la propuesta que creaste deberá tener agregadas las etiquetas que especificaste.
Pasos siguientes
- Para más información sobre las tareas adicionales que puedes realizar con la acción
actions/github-script
, como agregar reacciones, visita la documentación de la acciónactions/github-script
. - Para obtener más información acerca de los distintos eventos que pueden desencadenar el flujo de trabajo, consulta "Eventos que desencadenan flujos de trabajo".
- Busque en GitHub ejemplos de flujos de trabajo mediante esta acción.