Verificar plantillas de correo en CI

Antes de empezar

• Instala la bird CLI con una versión fija, para que una nueva versión nunca cambie tu pipeline sin aviso.
• Crea una clave API con acceso de lectura a email_management y ponla a disposición del job como BIRD_API_KEY.

Verificar una plantilla

bird email templates check welcome-email order-shipped

• Compatibilidad con clientes de correo: los mismos hallazgos de compatibilidad que muestra la vista previa de la plantilla, como CSS que un cliente elimina o ignora.
• Tamaño: el cuerpo HTML frente al punto de recorte de Gmail, de unos 102 KB. Gmail oculta todo lo que lo supere detrás de un enlace. Por encima de 90 KB la verificación advierte, ya que los valores de combinación pueden hacer que un mensaje lo supere.
• Enlaces e imágenes: cada URL http y https en un enlace (<a> y <area>), una fuente de imagen o srcset, un atributo background, o un url() de CSS en un atributo style o un bloque <style>, consultados desde donde se ejecuta el comando. Un 404, 410 o 5xx, o un host que no existe, es un problema. Un 401, 403 o 429, o una búsqueda DNS que expira, es una advertencia, porque normalmente significa que el runner fue rechazado o no pudo alcanzar el host. Los enlaces a direcciones privadas o de loopback nunca se consultan. Pasa --skip-links en un runner sin acceso de red saliente.

Verificar un archivo que tu build renderiza

bird email templates check --html dist/welcome.html --template welcome-email --annotations github

Códigos de salida

Ejecutar en GitHub Actions

name: Email templates
on:
  pull_request:
    paths: ["emails/**"]
jobs:
  check:
    # Pull requests from forks get no repository secrets, so the check could only exit 4.
    if: ${{ !github.event.pull_request.head.repo.fork }}
    runs-on: ubuntu-latest
    env:
      BIRD_API_KEY: ${{ secrets.BIRD_API_KEY }}
    steps:
      - uses: actions/checkout@v4
      - name: Install the bird CLI
        run: curl -fsSL https://cli.bird.com/install.sh | sh -s -- --version "${{ vars.BIRD_CLI_VERSION }}"
      - name: Build the templates
        run: npm ci && npm run build:emails
      - name: Check the templates
        run: |
          status=0
          for file in dist/emails/*.html; do
            bird email templates check --html "$file" --template welcome-email --annotations github || status=$?
          done
          exit "$status"

Solución de problemas

• Exit 3. La plantilla no está en el espacio de trabajo al que pertenece la clave API. Lista las plantillas del espacio de trabajo con bird email templates list.
• Exit 4. La clave no tiene acceso de lectura a email_management, o el secreto no está llegando al job.
• Todos los enlaces fallan con una advertencia. El runner no tiene acceso de red saliente, o un firewall lo bloquea. Ejecuta con --skip-links en ese caso, y verifica los enlaces desde un runner que pueda acceder a internet.

Próximos pasos

• Plantillas de correo: crea, previsualiza y publica plantillas en cada idioma
• bird email templates check: todas las opciones que acepta el comando
• La bird CLI: instala una versión fija y autentícate en CI