Programar la creación de propuestas

Introducción

Este tutorial ilustra cómo utilizar la acción imjohnbo/issue-bot para crear una propuesta con frecuencia. Por ejemplo, puedes crear una propuesta semanalmente o utilizarla como el itinerario de una junta de equipo.

En el tutorial, primero crearás un archivo de flujo de trabajo que utilice la acción imjohnbo/issue-bot. 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: Weekly Team Sync
   on:
     schedule:
       - cron: 20 07 * * 1
   
   jobs:
     create_issue:
       name: Create team sync issue
       runs-on: ubuntu-latest
       steps:
         - name: Create team sync issue
           uses: imjohnbo/issue-bot@3daae12aa54d38685d7ff8459fc8a2aee8cea98b
           with:
             assignees: "monalisa, doctocat, hubot"
             labels: "weekly sync, docs-team"
             title: "Team sync"
             body: |
               ### Agenda
   
               - [ ] Start the recording
               - [ ] Check-ins
               - [ ] Discussion points
               - [ ] Post the recording
   
               ### Discussion Points
               Add things to discuss below
   
               - [Work this week](https://github.com/orgs/github/projects/3)
             pinned: false
             close-previous: false
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

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

   • Cambia el valor de on.schedule para que dicte cuándo quieres que se ejecute este flujo de trabajo. En el ejemplo anterior, el flujo de trabajo se ejecutará cada lunes a las 7:20 UTC. Para obtener más información sobre los flujos de trabajo que has programado, consulta la sección "Ejemplos programados".
   • Cambia el valor de assignees a la lista de nombres de usuarios de GitHub que quieras asignar a la propuesta.
   • Cambia el valor de labels a la lista de etiquetas que quieras aplicar a la propuesta.
   • Cambia el valor de title al título que quieres que tenga la propuesta.
   • Cambia el valor de body al texto que quieras en el cuerpo de la propuesta. El caracter | te permite utilizar un valor de línea múltiple para este parámetro.
   • Si quieres fijar esta propuesta en tu repositorio, configura pinned en true. Para obtener más información acerca de las propuestas fijas, consulta "Fijar una propuesta a tu repositorio".
   • Si quieres cerrar la propuesta previa que generó este flujo de trabajo cada vez que se crea una propuesta nueva, configura close-previous en true. El flujo de trabajo cerrará la propuesta más reciente que tenga las etiquetas que se definen en el campo labels. Para evitar que se cierre la propuesta equivocada, utiliza una etiqueta única o una combinación de etiquetas.

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

Resultados esperados

Con base en el parámetro schedule (por ejemplo, cada lunes a las 7:20 UTC), tu flujo de trabajo creará una propuesta con los asignados, etiquetas, título y cuerpo que especifiques. Si configuras pinned como true, el flujo de trabajo fijará la propuesta a tu repositorio. Si configuras close-previous como "true", el flujo de trabajo cerrará la propuesta más reciente con las etiquetas coincidentes.

Puedes ver el historial de tus ejecuciones de flujo de trabajo para ver que este flujo de trabajo se ejecute regularmente. Para obtener más información, consulta la sección "Visualizar el historial de ejecuciones de un flujo de trabajo".

Pasos siguientes

• Para aprender más sobre las cosas adicionales que puedes hacer con la acción imjohnbo/issue-bot, como rotar asignados o utilizar una plantilla de propuesta, consulta la documentación de la acción imjohnbo/issue-bot.
• Busca en GitHub los ejemplos de los flujos de trabajo que utilizan esta acción.