[v1.0.0] Alpha to Stable Deployment by aaronginder · Pull Request #1 · aaronginder/html-email-generator

aaronginder · 2024-12-25T22:29:41Z

Title

Release html email generator library

Description

What

This pull request releases the initial stable release of the html email generator library built in Python. Users are able to use this library to generate HTML files that can be embedded into emails to allow for a professional look to an email in an easy, yaml-config driven manner.

Why

Initial release.

How

Change python to python3.12 in tests and add package-lock.json (1a21f0d)
Clear changelog and remove tags (85480a4)
Remove example output from readme (9783a2b)
Add examples (6d581b0)
Add logging, error handling and clean up (4330061)
Add semantic release workflow (012745c)
Add library code for HTML generator class

Impact

No breaking changes.
Initial stable release

Testing

Unit Tests

Add unit tests and github actions workflow for tests (df792e7)
Update test workflow to use poetry to install Python dependencies (810c2d4)
Update test workflow to include test packer code (4aab2ec)
Add dependency between test and release workflow (8507d9e)

Integration Tests

None

Manual Testing

Tested locally and sent HTML emails using output file generated by this library

Checklist

Additional Comments

None

…stallation

# 1.0.0-alpha.1 (2024-12-25) ### Bug Fixes * add dependency between test and release workflow ([8507d9e](8507d9e)) * change python to python3.12 in tests and add package-lock.json ([1a21f0d](1a21f0d)) * remove example output from readme ([9783a2b](9783a2b)) * update test workflow to use poetry to install Python dependencies ([810c2d4](810c2d4)) ### Features * add examples ([6d581b0](6d581b0)) * add semantic release workflow ([012745c](012745c)) * add unit tests ([92e2539](92e2539)) * Add unit tests and github actions workflow for tests ([df792e7](df792e7))

# 1.0.0-alpha.1 (2024-12-26) ### Bug Fixes * add dependency between test and release workflow ([8507d9e](8507d9e)) * change python to python3.12 in tests and add package-lock.json ([1a21f0d](1a21f0d)) * remove example output from readme ([9783a2b](9783a2b)) * update test workflow to use poetry to install Python dependencies ([810c2d4](810c2d4)) ### Features * add examples ([6d581b0](6d581b0)) * add logging, error handling and clean up ([4330061](4330061)) * add semantic release workflow ([012745c](012745c)) * add unit tests ([92e2539](92e2539)) * Add unit tests and github actions workflow for tests ([df792e7](df792e7))

…erator into alpha

# 1.0.0-alpha.1 (2024-12-26) ### Bug Fixes * add dependency between test and release workflow ([8507d9e](8507d9e)) * change python to python3.12 in tests and add package-lock.json ([1a21f0d](1a21f0d)) * remove example output from readme ([9783a2b](9783a2b)) * update test workflow to include test packaer code ([4aab2ec](4aab2ec)) * update test workflow to use poetry to install Python dependencies ([810c2d4](810c2d4)) ### Features * add examples ([6d581b0](6d581b0)) * add logging, error handling and clean up ([4330061](4330061)) * add semantic release workflow ([012745c](012745c)) * add unit tests ([92e2539](92e2539)) * Add unit tests and github actions workflow for tests ([df792e7](df792e7))

# 1.0.0-alpha.1 (2024-12-26) ### Bug Fixes * add dependency between test and release workflow ([8507d9e](8507d9e)) * change python to python3.12 in tests and add package-lock.json ([1a21f0d](1a21f0d)) * clear changelog and remove tags ([85480a4](85480a4)) * remove example output from readme ([9783a2b](9783a2b)) * update test workflow to include test packaer code ([4aab2ec](4aab2ec)) * update test workflow to use poetry to install Python dependencies ([810c2d4](810c2d4)) ### Features * add examples ([6d581b0](6d581b0)) * add logging, error handling and clean up ([4330061](4330061)) * add semantic release workflow ([012745c](012745c)) * add unit tests ([92e2539](92e2539)) * Add unit tests and github actions workflow for tests ([df792e7](df792e7))

Installation section had `pip install -r poetry` but should be `pip install poetry`

+

Copilot

Pull Request Overview

This PR delivers the initial stable release (v1.0.0) of the Python-based HTML email generator library, including core generation logic, tests, examples, and CI/CD setup.

Introduces EmailHTMLGenerator class with YAML-driven HTML/email generation and embedded Base64 images
Adds comprehensive unit tests and sample YAML configurations
Sets up CLI, documentation (README), and semantic-release workflows

Reviewed Changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
emailer/generator.py	Core generator implementation with section- and image-builders
tests/unittests/test_email_html_generator.py	Unit tests for config loading and HTML generation
emailer/cli.py	CLI entrypoint for invoking the generator
samples/*.yaml	Example configurations for various email templates
pyproject.toml	Package metadata and dependency configuration
README.md	User documentation and usage guide
.github/workflows/*.yaml	CI tests and release workflows
RELEASE_NOTES.md	Release notes for v1.0.0

Comments suppressed due to low confidence (3)

samples/functionality.yaml:8

Invalid section type "headers"—the generator expects "header". Update to match the supported types or enhance validation.

- type: "headers"

README.md:3

Filename typo in the image path: newletter_header.jpg should likely be newsletter_header.jpg to match the project name.

<img src="assets/newletter_header.jpg">

emailer/generator.py:175

There are no unit tests covering build_block_section or link/button rendering. Consider adding tests for block layouts and build_link_column to ensure coverage.

elif section_type == "block":

Copilot · 2025-05-25T22:04:37Z

+            <title>{title}</title>
+            <style>


The HTML template string duplicates <title> and <style> tags (lines 88–91). Remove the extra <title> and redundant <style> to ensure valid head markup.

Suggested change

<title>{title}</title>

<style>

Copilot · 2025-05-25T22:04:37Z

+        button_height = column.get("styles", {}).get("button-height", "auto")  # Default to 16px if not provided
+        button_height = column.get("styles", {}).get("background-button-color", "none") 


The next line overwrites button_height with background-button-color. This looks like a typo—use separate variables for height and background color or correct the key lookup.

Suggested change

button_height = column.get("styles", {}).get("button-height", "auto") # Default to 16px if not provided

button_height = column.get("styles", {}).get("background-button-color", "none")

button_height = column.get("styles", {}).get("button-height", "auto") # Default to "auto" if not provided

background_button_color = column.get("styles", {}).get("background-button-color", "none") # Default to "none" if not provided

Copilot · 2025-05-25T22:04:38Z

+            str: The Content-ID (CID) for the image.
+        """
+        cid = os.path.basename(image_path).replace(".", "_")
+        self.inline_images[cid] = image_path


The inline_images dictionary is never initialized in __init__. Add self.inline_images = {} before it's first used to avoid an AttributeError.

Copilot · 2025-05-25T22:04:38Z

+@mock.patch("builtins.open", new_callable=mock.mock_open)
+def test_generate_html(mock_open, mock_exists, mock_yaml_file, mock_config):
+    """Test generating HTML from the configuration."""
+    with mock.patch("main.utils.email_html_generator.EmailHTMLGenerator.load_config", return_value=mock_config):


The import path for patching load_config is incorrect. The class lives in emailer.generator, so patch emailer.generator.EmailHTMLGenerator.load_config instead.

Suggested change

with mock.patch("main.utils.email_html_generator.EmailHTMLGenerator.load_config", return_value=mock_config):

with mock.patch("emailer.generator.EmailHTMLGenerator.load_config", return_value=mock_config):

Copilot · 2025-05-25T22:04:38Z

+# The template has the following sections:
+#   - Image header as a banner of the email
+#   - Details of who the email is from and for, and purpose
+#   - Paragarph of the details of the email, including any updates


Typo in comment: "Paragarph" should be spelled "Paragraph".

Suggested change

# - Paragarph of the details of the email, including any updates

# - Paragraph of the details of the email, including any updates

Copilot · 2025-05-25T22:04:38Z

+# Professional Newsletter Template
+# A template for creating a professional-looking newsletter. This template includes a header, an introductory paragraph, a main content section, and a footer with an image.
+
+title: "Corporate Anouncement"


Typo in the title: "Anouncement" should be spelled "Announcement".

Suggested change

title: "Corporate Anouncement"

title: "Corporate Announcement"

aaronginder and others added 13 commits December 20, 2024 17:28

feat: Add unit tests and github actions workflow for tests

df792e7

rename tests workflow

34745ec

fix: update test workflow to use poetry to install Python dependencies

810c2d4

feat: add semantic release workflow

012745c

fix: change python to python3.12 in tests and add package-lock.json

1a21f0d

update workflow to refer to correct python during tests and poetry in…

f041dce

…stallation

feat: add unit tests

92e2539

Added verbose logging for test package workflow

33c9816

feat: add examples

6d581b0

fix: remove example output from readme

9783a2b

merge develop to alpha

8292b07

fix: add dependency between test and release workflow

8507d9e

aaronginder self-assigned this Dec 25, 2024

aaronginder added enhancement New feature or request documentation Improvements or additions to documentation labels Dec 25, 2024

aaronginder added 2 commits December 26, 2024 11:22

feat: add logging, error handling and clean up

4330061

remove main from tests folder

2dd3cc9

aaronginder force-pushed the alpha branch from 6c13b22 to 2dd3cc9 Compare December 26, 2024 17:50

semantic-release-bot and others added 11 commits December 26, 2024 17:50

Add Apache License 2.0 and NOTICE file

1408b10

Merge branch 'alpha' of https://github.com/aaronginder/html-email-gen…

bd26f04

…erator into alpha

fix: update test workflow to include test packaer code

4aab2ec

clear changelog

d4bda7a

fix: clear changelog and remove tags

85480a4

aaronginder and others added 8 commits December 26, 2024 18:12

chore: update release notes v1.0.0-alpha.1

def07e9

chore: remove unit test statement from readme

3bcd909

chore: update workflows

47ec44b

chore: Remove typo in README.md

b6a9d6a

Installation section had `pip install -r poetry` but should be `pip install poetry`

feat: add deployment process with poetry and package build

9166e5d

chore(release): 1.0.0-alpha.2 [skip ci]

e13e8b6

update poetry branches in pyproject.toml for semantic-release

2d7f2c0

chore(release): 1.0.0-alpha.3 [skip ci]

281c485

+

aaronginder force-pushed the alpha branch from aaa1290 to 281c485 Compare May 24, 2025 21:54

chore(release): 1.0.0-alpha.4 [skip ci]

a82f47d

aaronginder requested a review from Copilot May 25, 2025 22:02

aaronginder merged commit d8f0e7c into main May 25, 2025
1 of 2 checks passed

Copilot AI reviewed May 25, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[v1.0.0] Alpha to Stable Deployment#1

[v1.0.0] Alpha to Stable Deployment#1
aaronginder merged 35 commits intomainfrom
alpha

aaronginder commented Dec 25, 2024 •

edited

Loading

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI May 25, 2025

Uh oh!

Copilot AI May 25, 2025

Uh oh!

Copilot AI May 25, 2025

Uh oh!

Copilot AI May 25, 2025

Uh oh!

Copilot AI May 25, 2025

Uh oh!

Copilot AI May 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		button_height = column.get("styles", {}).get("button-height", "auto") # Default to 16px if not provided
		button_height = column.get("styles", {}).get("background-button-color", "none")

	with mock.patch("main.utils.email_html_generator.EmailHTMLGenerator.load_config", return_value=mock_config):
	with mock.patch("emailer.generator.EmailHTMLGenerator.load_config", return_value=mock_config):

	# - Paragarph of the details of the email, including any updates
	# - Paragraph of the details of the email, including any updates

	title: "Corporate Anouncement"
	title: "Corporate Announcement"

Conversation

aaronginder commented Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Title

Description

What

Why

How

Impact

Testing

Unit Tests

Integration Tests

Manual Testing

Checklist

Additional Comments

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI May 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 25, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 25, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

aaronginder commented Dec 25, 2024 •

edited

Loading