From 3cf07ebfbdef2dd0b16edccd94e94c334f512913 Mon Sep 17 00:00:00 2001 From: Will Estes Date: Mon, 20 Jul 2026 14:29:50 -0400 Subject: [PATCH] Customize campaigns-template for cateconners.com Rename default template, restyle campaign email to the Fantasy Michigan palette, write a short domain-specific README. --- .gitea/workflows/sync-template.yml | 4 +- README.md | 41 +++++++++------------ email-templates/campaign.html | 59 +++++++++++++++--------------- 3 files changed, 48 insertions(+), 56 deletions(-) diff --git a/.gitea/workflows/sync-template.yml b/.gitea/workflows/sync-template.yml index 2381b7f..9c9f33c 100644 --- a/.gitea/workflows/sync-template.yml +++ b/.gitea/workflows/sync-template.yml @@ -15,10 +15,8 @@ jobs: - name: Install eec-campaigns run: go install gitea.reground.org/will/eec-campaigns@v0.1.0 - # TODO: rename "TEMPLATE default" below to " default" - # (or any name you like) as part of customizing this template. - name: Sync template to listmonk - run: eec-campaigns template "TEMPLATE default" email-templates/campaign.html + run: eec-campaigns template "cateconners default" email-templates/campaign.html env: LISTMONK_BASE_URL: ${{ secrets.CAMPAIGNS_LISTMONK_BASE_URL }} LISTMONK_API_USER: ${{ secrets.CAMPAIGNS_LISTMONK_API_USER }} diff --git a/README.md b/README.md index e003318..676b427 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,23 @@ -# campaigns-template +# cateconners-campaigns -Gitea template repo for standing up a new domain/client's campaign content repo. Generate a new repo from this one (Gitea → this repo → "Generate Repo," or `POST /api/v1/repos/generate/will/campaigns-template`) rather than cloning it — generating starts the new repo with a clean history of its own. +cateconners.com's campaign content, synced to listmonk by [`eec-campaigns`](https://gitea.reground.org/will/eec-campaigns). This repo holds only campaign content and this domain's listmonk secrets — the tool itself is installed at a pinned version in CI. -Full reference for everything below lives in the [`eec-campaigns` README](https://gitea.reground.org/will/eec-campaigns). +## To send a campaign -## After generating a new repo from this template +1. Write `campaigns//campaign.md` (frontmatter + Markdown body — see the [eec-campaigns README](https://gitea.reground.org/will/eec-campaigns#campaignmd) for the full field reference). Set `from` explicitly to `Cate Conners ` — Mailcow's Sender ACL only allows that exact address for this domain. +2. `git push` to `master` — CI syncs it into listmonk as a **draft** and emails a preview to `CAMPAIGNS_PREVIEW_EMAIL` (or the campaign's own `preview_emails`). +3. Check the preview inbox. Keep pushing edits until it looks right — each push re-syncs and re-previews. +4. When ready to actually send: `git tag send/ && git push origin send/`. This is the one action that transitions the campaign from draft to running — a plain `git push` to master can never do it. -1. **Rename the template.** In `.gitea/workflows/sync-template.yml`, replace `TEMPLATE default` with a name specific to this domain (e.g. ` default`). -2. **Restyle `email-templates/campaign.html`** if this client wants different branding than the stock listmonk template it starts as. -3. **Add repo secrets** (Gitea Actions → Secrets): `CAMPAIGNS_LISTMONK_BASE_URL`, `CAMPAIGNS_LISTMONK_API_USER`, `CAMPAIGNS_LISTMONK_API_TOKEN`, and optionally `CAMPAIGNS_PREVIEW_EMAIL` — scoped to this domain's own listmonk instance and its own dedicated API user (see `reground-infrastructure`'s `campaigns` Ansible role for provisioning that user). -4. **Check the tool version pin** in all four `.gitea/workflows/*.yml` files (currently `v0.1.0`) — bump it only deliberately, after confirming a newer `eec-campaigns` release works. -5. Run the `Sync default campaign template` workflow once. -6. Replace this README with a short one for this domain (see `reground-campaigns`'s README for the pattern: a numbered "to send a campaign" list for whoever operates this repo day-to-day). -7. Give the client push/PR access to *this repo only* — that's the entire isolation boundary. They never need access to `eec-campaigns`, `campaigns-template`, or any other domain's repo. +Alternatively, run the `Send campaign` workflow manually from Gitea Actions with the slug as input — same effect as the tag push. -## Layout +## Other workflows -``` -campaigns/ - / - campaign.md -email-templates/ - campaign.html -.gitea/workflows/ - sync.yml # push to master -> draft + preview - send.yml # tag push send/, or manual dispatch -> real send - test.yml # manual dispatch -> re-preview without touching status - sync-template.yml # manual dispatch -> push email template as listmonk default -``` +- **`Test-send campaign`** (manual) — re-preview a campaign's current content to any address, without touching its status. +- **`Sync default campaign template`** (manual) — pushes `email-templates/campaign.html` into listmonk as the default campaign template. Run once after setup, and again whenever that file changes. + +## Setup (one-time) + +Repo secrets (Gitea Actions → Secrets): `CAMPAIGNS_LISTMONK_BASE_URL`, `CAMPAIGNS_LISTMONK_API_USER`, `CAMPAIGNS_LISTMONK_API_TOKEN`, `CAMPAIGNS_PREVIEW_EMAIL`. + +The workflows in `.gitea/workflows/` pin a specific `eec-campaigns` version (currently `v0.1.0`). Bump that pin deliberately when a new tool version is ready, not automatically. diff --git a/email-templates/campaign.html b/email-templates/campaign.html index c83add3..4e85358 100644 --- a/email-templates/campaign.html +++ b/email-templates/campaign.html @@ -1,14 +1,14 @@ @@ -19,56 +19,57 @@ just Listmonk's default look. - +
 
-
+
{{ template "content" . }}
-
+

- {{ L.T "email.unsub" }} + {{ L.T "email.unsub" }}    - {{ L.T "email.viewInBrowser" }} + {{ L.T "email.viewInBrowser" }}

 {{ TrackView }}