Este documento está basado en el artículo sobre AppVeyor, disponible en la documentación sobre desarrollo de complementos de esta web.

Procedimiento para construir, comprobar estilo y adjuntar archivos nvda-addon a liberaciones de GitHub

Configuración de acciones de GitHub para complementos

Esto funciona con complementos basados en la plantilla de complemento.

  1. Consigue el código de un complemento.
    Ejemplo:
    «`
    git clone https://github.com/usuario/repo
    git pull
    «`
    2. En la carpeta raíz del complemento (donde se encuentra el archivo sconstruct), pega este archivo de configuración de Flake8, que usa reglas de Flake8 configuradas para NVDA. El archivo debe llamarse setup.cfg
  2. En la carpeta raíz del repositorio del complemento, crea la subcarpeta .github/workflows.
  3. Dentro de la subcarpeta carpetaRaízRepositorio/.github/workflows, se puede pegar este archivo de flujo de trabajo de GitHub. La extensión del archivo debería ser .yml (o .yaml).
  4. El flujo de trabajo anterior se disparará en eventos push y ante solicitudes de cambio.
  5. Se mostrarán los errores detectados por Flake8, pero estos no detendrán el flujo de trabajo, de tal forma que el complemento pueda construirse y liberarse incluso si se encuentran fallos de estilo o sintaxis.

Aquí hay más información sobre visualización y gestión de flujos de trabajo de GitHub.

Liberaciones

Para publicar una nueva versión de un complemento, puedes crear una nueva etiqueta y enviar los cambios a GitHub:

Ejemplo

git tag 1.0

git push origin 1.0

Ahora, se creará la liberación en GitHub y se adjuntará el archivo binary-1.0.nvda-addon.

Con el archivo yaml proporcionado, las liberaciones creadas a partir de etiquetas que terminen en «-dev» se marcarán como en desarrollo.

Ejemplo

git tag 1.0-dev

git push origin 1.0-dev

Referencias

Documentación

Acciones utilizadas

Ejemplo real