From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>
Subject: Re: [pbs-devel] [PATCH proxmox-backup 00/10] notifications: cleanup in preparation of overridable templates
Date: Fri, 21 Mar 2025 13:38:13 +0100 [thread overview]
Message-ID: <s8o8qoyfteg.fsf@proxmox.com> (raw)
In-Reply-To: <20250321122521.198725-1-l.wagner@proxmox.com>
Lukas Wagner <l.wagner@proxmox.com> writes:
> When the notification system was brought to PBS, the template strings
> were moved to the template files as they were, without any changes.
> The original templates were an implementation detail which were not
> exposed to the user in any way.
> They were bit inconsistent with regards to how template variables were
> named (e.g. '{{datastore}}', '{{store}}', '{{job.store}}' for
> referring to a datastore), as well es how variables/helpers
> were accessed ({{ var }} vs {{var}}).
>
> With [#6143] on the horizon, notification templates, template variables
> and template helpers become part of our public API and as such
> we should provide some stability guarantees for them.
> As a result, we use this opportunity to do a 'final' cleanup.
>
> The aims of this series are:
> - cleanup inconsistencies in the existing templates
> - add custom types which are used to pass template variables
> to the notification system, serving as documentation of what
> is passed exactly to each template, as well as protection
> against accidentally leaking interal code changes into
> the template rendering process
>
> This series also removes the HTML version of the test notification template.
> In PBS, this was the only template for which we shipped an HTML version.
> This might bee a bit confusing for users writing their own templates,
> hence it is removed. If we ever add HTML templates for the other notification
> types we can add it back.
>
> [#6143] https://bugzilla.proxmox.com/show_bug.cgi?id=6143
I went through this patch series and it looks good to me.
Reviewed-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
next prev parent reply other threads:[~2025-03-21 12:41 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-03-21 12:25 Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 01/10] notifications: move make notifications module a dir-style module Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 02/10] notifications: add type for GC notification template data Lukas Wagner
2025-03-21 13:28 ` Wolfgang Bumiller
2025-03-24 8:32 ` Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 03/10] notifications: add type for ACME " Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 04/10] notifications: add type for APT " Lukas Wagner
2025-03-24 10:39 ` Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 05/10] notifications: add type for prune " Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 06/10] notifications: add type for sync " Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 07/10] notifications: add type for tape backup " Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 08/10] notifications: add type for tape load " Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 09/10] notifications: add type for verify " Lukas Wagner
2025-03-21 12:25 ` [pbs-devel] [PATCH proxmox-backup 10/10] notifications: remove HTML template for test notification Lukas Wagner
2025-03-21 12:38 ` Maximiliano Sandoval [this message]
2025-03-27 14:57 ` [pbs-devel] superseded: [PATCH proxmox-backup 00/10] notifications: cleanup in preparation of overridable templates Lukas Wagner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=s8o8qoyfteg.fsf@proxmox.com \
--to=m.sandoval@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal