Comentar en una propuesta cuando se le agrega una etiqueta

Introducción

Este tutorial ilustra cómo utilizar la acción peter-evans/create-or-update-comment para comentar en una propuesta cuando se le aplica una etiqueta específica. Por ejemplo, cuando se agrega la etiqueta help-wanted a una propuesta, puedes agregar un comentario para animar a los colaboradores a que trabajen sobre dicha propuesta.

En el tutorial, primero harás un archivo de flujo de trabajo que utilice 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 obtener más información sobre la creación de repositorios, consulta "Crear un repositorio nuevo."

2. En tu repositorio, crea un archivo que se llame .github/workflows/YOUR_WORKFLOW.yml, reemplazando a YOUR_WORKFLOW con un nombre de tu elección. Este es un archivo de flujo de trabajo. Para obtener más información acerca de cómo crear archivos nuevos en GitHub, consulta la sección "Crear archivos nuevos".

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

   YAML

   # This workflow uses actions that are not certified by GitHub.
   # Estas las proporcionan entidades terceras y las gobiernan
   # condiciones de servicio, políticas de privacidad y documentación de soporte
   # documentación.
   
   name: Add comment
   on:
     issues:
       types:
         - labeled
   jobs:
     add-comment:
       if: github.event.label.name == 'help-wanted'
       runs-on: ubuntu-latest
       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:

   • Reemplaza a help-wanted en if: github.event.label.name == 'help-wanted' con la etiqueta sobre la cual quieres actuar. Si quieres actuar sobre más de una etiqueta, separa las condiciones con ||. Por ejemplo, if: github.event.label.name == 'bug' || github.event.label.name == 'fix me' comentará cada que se agreguen las etiquetas bug o fix me a una propuesta.
   • Cambia el valor de body al comentario que quieras agregar. El lenguaje de marcado enriquecido de GitHub es compatible. Para obtener más información sobre el lenguaje de marcado, consulta la sección "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, consulta "Crear nuevos archivos."

Probar 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 agregó es una de las que especificaste en tu archivo de flujo de trabajo, la acción peter-evans/create-or-update-comment agregará el comentario que especificaste a la propuesta.

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, consulta la sección "Crear una propuesta".
2. Etiqueta la propuesta con la etiqueta que se especificó en tu flujo de trabajo. Para obtener más información, consulta la sección "Administrar 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, consulta la sección "Visualizar el historial de ejecuciones de un flujo de trabajo".
4. Cuando se complete el flujo de trabajo, la propuesta que etiquetaste debe tener un comentario agregado.

Pasos siguientes

• Para aprender más sobre las cosas adicionales que puedes hacer con la acción peter-evans/create-or-update-comment, como agregar reacciones, visita la documentación de la acción peter-evans/create-or-update-comment.