Sign inGet Started

bird email templates check

Usage

代码示例
bird email templates check [template-ref...] [flags]

Description

Renders each template's draft, in every language it has, and checks what a CI job needs: the compatibility findings preview reports, the HTML size against Gmail's clipping point (about 102 KB), and every link and image, fetched from where the command runs. It exits 7 (check_failed) when any finding is a problem; warnings are reported and never fail.
--html checks a file your build renders instead of a stored template. It is previewed as unsaved content against the template named by --template, so no draft is changed; any template works.
--annotations github prints GitHub Actions workflow commands on stdout instead of the report, so findings in an --html file appear on its lines in the pull request.

Examples

代码示例
bird email templates check welcome-email order-shipped
bird email templates check --html dist/welcome.html --template welcome-email --annotations github

Options

NameDescription
--annotationsPrint findings as CI annotations instead of the report: github
--htmlPath to a rendered HTML file to check instead of a stored template's draft; needs --template
--skip-linksSkip fetching links, for runners without outbound network access
--templateTemplate to preview --html against (id or slug); its stored content is not used
NameDescription
bird email templates createCreate an email template and its first editable draft
bird email templates deleteDelete an email template
bird email templates duplicateDuplicate an email template
bird email templates getGet an email template
bird email templates listList email templates
bird email templates previewPreview a template with sample values
bird email templates updateUpdate an email template