Comentar en una propuesta cuando se le agrega una etiqueta

Introducción

En este tutorial se muestra cómo usar la acción peter-evans/create-or-update-comment 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.

En el tutorial, primero creará un archivo de flujo de trabajo en el que se usa la acción peter-evans/create-or-update-comment. 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, vea "Creación de un repositorio".

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 más información sobre cómo crear archivos en GitHub, vea "Creación de archivos".

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

   YAML

   # Este flujo de trabajo usa acciones que no GitHub no certifica.
   # Estas las proporcionan entidades terceras y las gobiernan
   # condiciones de servicio, políticas de privacidad y documentación de soporte
   # en línea.
   
   # GitHub recomienda anclar acciones a un SHA de confirmación.
   # Para obtener una versión más reciente, debes actualizar el SHA.
   # También puedes hacer referencia a una etiqueta o rama, pero la acción puede cambiar sin ninguna advertencia.
   
   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
           uses: peter-evans/create-or-update-comment@a35cf36e5301d70b76f316e867e7788a55a31dae
           with:
             issue-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 Markdown, vea "Sintaxis básica de escritura y formato".

5. Confirma tu archivo de flujo de trabajo en la rama predeterminada de tu repositorio. Para obtener más información, consulte "Creación de 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, la acción peter-evans/create-or-update-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 más información, vea "Creación de una incidencia".
2. Etiqueta la propuesta con la etiqueta que se especificó en tu flujo de trabajo. Para más información, vea "Administración de 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 más información, vea "Visualización del historial de ejecución de flujo de trabajo".
4. Cuando se complete el flujo de trabajo, la propuesta que etiquetaste debe tener un comentario agregado.

Pasos siguientes

• Para más información sobre las tareas adicionales que puede realizar con la acción peter-evans/create-or-update-comment, como agregar reacciones, visite la documentación de la acción peter-evans/create-or-update-comment.