Comentar en una propuesta cuando se le agrega una etiqueta

Introducción

En este tutorial se muestra cómo usar la GitHub CLI para comentar una incidencia cuando se aplica una etiqueta específica. Por ejemplo, cuando se agrega la etiqueta help wanted a una incidencia, se puede agregar un comentario para animar a los colaboradores a que trabajen en esa incidencia. Para más información sobre GitHub CLI, consulte "Utilizar el CLI de GitHub en los flujos de trabajo".

En el tutorial, primero creará un archivo de flujo de trabajo en el que se usa el comando gh issue comment para comentar una incidencia. Después, personalizarás el flujo de trabajo de acuerdo con tus necesidades.

Crear un flujo de trabajo

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

2. En el repositorio, cree un archivo denominado .github/workflows/YOUR_WORKFLOW.yml, y reemplace YOUR_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".

3. Copia el siguiente contenido de YAML en tu archivo de flujo de trabajo.

   YAML

   name: Add comment
   on:
     issues:
       types:
         - labeled
   jobs:
     add-comment:
       if: github.event.label.name == 'help wanted'
       runs-on: ubuntu-latest
       permissions:
         issues: write
       steps:
         - name: Add comment
           run: gh issue comment "$NUMBER" --body "$BODY"
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
             GH_REPO: ${{ github.repository }}
             NUMBER: ${{ github.event.issue.number }}
             BODY: >
               This issue is available for anyone to work on.
               **Make sure to reference this issue in your pull request.**
               :sparkles: Thank you for your contribution! :sparkles:
   

4. Personaliza los parámetros en tu archivo de flujo de trabajo:

   • Reemplace help wanted en if: github.event.label.name == 'help wanted' por la etiqueta sobre la que quiera actuar. Si quiere actuar sobre más de una etiqueta, separe las condiciones con ||. Por ejemplo, if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' comentará cada vez que se agreguen las etiquetas bug o fix me a una incidencia.
   • Cambie el valor de BODY por el comentario que quiera agregar. El lenguaje de marcado enriquecido de GitHub es compatible. Para más información sobre el marcado, consulta "Sintaxis de escritura y formato básicos".

5. 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 vez que se etiqueta a una propuesta de tu repositorio, se ejecutará este flujo de trabajo. Si la etiqueta que se ha agregado es una de las especificadas en el archivo de flujo de trabajo, el comando gh issue comment agregará a la incidencia el comentario que haya especificado.

Prueba tu flujo de trabajo aplicando tu etiqueta especificada a una propuesta.

1. Abre una propuesta en tu repositorio. Para obtener más información, vea «Crear una propuesta».
2. Etiqueta la propuesta con la etiqueta que se especificó en tu flujo de trabajo. Para obtener más información, vea «Administrar las etiquetas».
3. Para ver la ejecución de flujo de trabajo que se activó al etiquetar la propuesta, visualiza 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».
4. Cuando se complete el flujo de trabajo, la propuesta que etiquetaste debe tener un comentario agregado.

Pasos siguientes

• Para obtener más información sobre las cosas adicionales que puede hacer con la CLI de GitHub, como editar comentarios existentes, consulte el Manual de la CLI de GitHub.