Automate social image generation by kacperlukawski · Pull Request #508 · deepset-ai/haystack-home

kacperlukawski · 2026-03-05T09:00:00Z

The social preview images are used by LinkedIn and X natively whenever someone shares a link to the website. This PR attempts to automate this process by using templates specific to the content type. It is possible to define how YAML frontmatter attributes are rendered over the image in a configuration file. Currently, the images are generated when the build.sh script is launched, but eventually should be run either as a GH bot or a pre-commit hook.

Requirements:

ImageMagick

vercel · 2026-03-05T09:00:06Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
haystack-home	Ready	Preview, Comment	Jun 23, 2026 10:06am

kacperlukawski · 2026-03-16T10:38:27Z

@bilgeyucel This PR is a draft, as I see it now more like a github action that runs this process and commits automatically. If we decide to add this, here is how the social preview image would look like:

bilgeyucel

Love this, thank you @kacperlukawski!

bilgeyucel · 2026-03-30T11:47:59Z

I see that emojis in the content title are not rendered in the thumbnail. I believe this problem causes the space in front of "Cookbook"

bilgeyucel · 2026-03-30T11:49:09Z

I love having them for integrations! Are they rendered once? What happens when we decide to change the description? Also, do we need to make further changes on the haystack-integrations repo, especially in the frontmatter of the pages?

socket-security · 2026-04-29T15:18:24Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff	Package	Supply Chain Security	Vulnerability	Quality	Maintenance	License
	pypi/python-frontmatter@1.3.0
	pypi/pyyaml@6.0.3

View full report

github-actions · 2026-06-23T10:00:36Z

Summary

Status	Count
🔍 Total	1524
🔗 Unique	562
✅ Successful	1423
⏳ Timeouts	0
🔀 Redirected	45
👻 Excluded	94
❓ Unknown	0
🚫 Errors	7
⛔ Unsupported	0

Errors per input

Errors in ./public/benchmarks/index.html

[404] https://github.com/deepset-ai/haystack/blob/master/test/benchmarks/reader.py (at 1297:689) | Rejected status code: 404 Not Found

Errors in ./public/nlp-resources/index.html

[ERROR] file:///home/runner/work/haystack-home/haystack-home/public/pipeline_nodes/reader#deeper-dive-from-language-model-to-haystack-reader (at 1412:10) | File not found. Check if file exists and path is correct
[403] https://elvissaravia.substack.com/p/learn-about-transformers-a-recipe?s=r (at 1436:10) | Rejected status code: 403 Forbidden
[403] https://medium.com/swlh/bert-139acce0592d (at 1428:10) | Rejected status code: 403 Forbidden
[404] https://towardsdatascience.com/intuitive-explanation-of-bert-bidirectional-transformers-for-nlp-cdc1efc69c1e (at 1420:10) | Rejected status code: 404 Not Found
[404] https://towardsdatascience.com/text-classification-with-nlp-tf-idf-vs-word2vec-vs-bert-41ff868d1794 (at 1285:10) | Rejected status code: 404 Not Found
[404] https://towardsdatascience.com/word-embeddings-for-nlp-5b72991e01d4 (at 1377:10) | Rejected status code: 404 Not Found

Full Github Actions output

…nfiguration

…improved layout and fallback handling

…nd new placement test script

… and FieldConfig for improved structure and maintainability

…r layout

…command usage

…ustments

…d release notes

…esults

… paths

This reverts commit 79b675f.

…lt path in FileProcessor

- Remove blog template (images not needed; posts have their own thumbnails) - Add exclude list (blog, authors) so generation skips those content types - Switch all title fields from Inter-Bold to HafferBold per reviewer request - Fix Integration.png template path case (was integration.png — broke on Linux CI) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

- Add _strip_emoji() helper that removes emoji, ZWJ, variation selectors, skin-tone modifiers, and regional indicators, then collapses whitespace - Apply stripping to title and description in ContentFile.load() — fixes the leading space before "Cookbook" caused by ImageMagick not rendering the 🧑‍🍳 emoji - Load exclude list from config.yaml (top-level `exclude:` key) in Config - Add Config.is_excluded() method - Skip excluded content types early in FileProcessor.process() Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Drop Courier Prime, all Greycliff CF variants, and Inter-Bold. Remaining fonts: HafferBold (titles), HafferMedium, HafferRegular, Inter-Regular (body text). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Blog posts have dedicated thumbnails in their frontmatter; author pages will fall back to the site-wide default OG image. Neither needs generated social images, and the generator is now configured to skip both types. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

- Update YAML example: GreycliffCFExtraBold → HafferBold, drop stale output_dir key - Update fonts list: remove Courier + Greycliff, list only Haffer + Inter - Fix templates table: Integration.png (correct case), cookbook.png, remove stale overview row - Document the new top-level exclude: config key Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

- Replace `convert` with `magick` to match generate.py and ImageMagick 7+ - Replace nonexistent template_cfg.output_dir with the standard path static/images/social/<type>/ used by FileProcessor Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Adds .github/workflows/social-images.yml, triggered on pull_request for any content/**/*.md change. The job installs ImageMagick 6 (with a `magick` alias for IM7 compatibility) and the Python deps, diffs the PR head against base to find added/modified/deleted files, runs generate.py --file --force for each changed file, git-rms orphaned PNGs for deleted markdown, then commits and pushes via GITHUB_TOKEN. Fork PRs emit a ::notice:: instead of pushing. build.sh is left untouched — it remains idempotent (skips existing images) and still generates images for external content types (tutorials, cookbook, integrations, advent-of-haystack) whose .md files are pulled at deploy time and are not present in this repo. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Images are now committed to the repo via the GitHub Action on each PR that changes content/*.md files. Regenerating at deploy time requires ImageMagick which isn't available in the build environment and adds unnecessary overhead. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

kacperlukawski · 2026-06-23T10:11:14Z

@bilgeyucel I would appreciate if you could have another look. I implemented the requested changes + created a github action that triggers the generation once there are any changes in the .md files and commits the images separately. There is a test PR created how that works here: #549

kacperlukawski added the documentation Improvements or additions to documentation label Mar 5, 2026

vercel Bot deployed to Preview March 12, 2026 19:28 View deployment

vercel Bot deployed to Preview March 12, 2026 19:41 View deployment

kacperlukawski force-pushed the social-image-generation branch from ac83321 to 279d351 Compare March 12, 2026 19:43

vercel Bot deployed to Preview March 12, 2026 19:44 View deployment

vercel Bot deployed to Preview March 16, 2026 10:05 View deployment

vercel Bot deployed to Preview March 16, 2026 14:42 View deployment

kacperlukawski requested a review from bilgeyucel March 25, 2026 10:57

kacperlukawski marked this pull request as ready for review March 25, 2026 10:57

kacperlukawski requested a review from a team as a code owner March 25, 2026 10:57

bilgeyucel reviewed Mar 31, 2026

View reviewed changes

kacperlukawski force-pushed the social-image-generation branch from 991c7e1 to 8bc3540 Compare April 29, 2026 15:18

vercel Bot deployed to Preview April 29, 2026 15:19 View deployment

kacperlukawski force-pushed the social-image-generation branch from 8bc3540 to aaf4a7f Compare June 1, 2026 08:40

vercel Bot deployed to Preview June 1, 2026 08:41 View deployment

kacperlukawski force-pushed the social-image-generation branch from aaf4a7f to 111f522 Compare June 22, 2026 14:00

vercel Bot deployed to Preview June 22, 2026 14:01 View deployment

vercel Bot deployed to Preview June 22, 2026 14:58 View deployment

vercel Bot deployed to Preview June 23, 2026 09:55 View deployment

vercel Bot deployed to Preview June 23, 2026 10:00 View deployment

kacperlukawski added 6 commits June 23, 2026 12:04

feat: add social image generation functionality with templates and co…

e034265

…nfiguration

fix: resolve single file path in collect_files function

542c3bb

feat: update social image generation configuration and templates for …

7e7f52d

…improved layout and fallback handling

feat: enhance social image generation with dynamic text positioning a…

94c7a22

…nd new placement test script

feat: refactor social image placement test to utilize ImageCompositor…

37f84f6

… and FieldConfig for improved structure and maintainability

fix: adjust font size and gap in social image configuration for bette…

3e1daf8

…r layout

kacperlukawski and others added 26 commits June 23, 2026 12:04

feat: add example social images for blog and Google GenAI integrations

6a8fac4

feat: update social image integration template and fonts

2164aaa

fix: adjust gap in social image configuration and update ImageMagick …

e7ab881

…command usage

feat: update social image configuration with new fonts and layout adj…

efcc8f3

…ustments

feat: update social image templates and configuration for cookbook an…

ae66d80

…d release notes

fix: improve output message format in FileProcessor for ImageMagick r…

7625fe9

…esults

fix: improve error and status messages in FileProcessor with relative…

7649301

… paths

feat: add --force option to regenerate images if they already exist

c2a4e14

Add new social images and release notes for various versions

1896926

Revert "Add new social images and release notes for various versions"

edd6614

This reverts commit 79b675f.

refactor: remove output_dir from template configuration and set defau…

1618a0d

…lt path in FileProcessor

Add example images

e4fbae7

fix: update social image path to use section instead of type

5dc3425

fix: ensure consistent text height measurement

0aa8039

chore: new images for integrations, release notes, and tutorials

4a5a776

chore(social-images): remove unused font files

d2b4699

Drop Courier Prime, all Greycliff CF variants, and Inter-Bold. Remaining fonts: HafferBold (titles), HafferMedium, HafferRegular, Inter-Regular (body text). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

chore(social-images): exclude ambassador-perks from image generation

09547f8

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

chore: regenerate images

a16b01f

docs(social-images): update README to reflect CI-based generation

3ae8d52

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

kacperlukawski force-pushed the social-image-generation branch from bf6bb8c to 3ae8d52 Compare June 23, 2026 10:05

vercel Bot deployed to Preview June 23, 2026 10:06 View deployment

kacperlukawski requested a review from bilgeyucel June 23, 2026 10:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automate social image generation#508

Automate social image generation#508
kacperlukawski wants to merge 32 commits into
mainfrom
social-image-generation

kacperlukawski commented Mar 5, 2026

Uh oh!

vercel Bot commented Mar 5, 2026 •

edited

Loading

Uh oh!

kacperlukawski commented Mar 16, 2026

Uh oh!

bilgeyucel left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bilgeyucel Mar 30, 2026

Uh oh!

bilgeyucel Mar 30, 2026

Uh oh!

Uh oh!

Uh oh!

socket-security Bot commented Apr 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jun 23, 2026 •

edited

Loading

Uh oh!

kacperlukawski commented Jun 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

kacperlukawski commented Mar 5, 2026

Uh oh!

vercel Bot commented Mar 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kacperlukawski commented Mar 16, 2026

Uh oh!

bilgeyucel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bilgeyucel Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

bilgeyucel Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

socket-security Bot commented Apr 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jun 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Errors per input

Errors in ./public/benchmarks/index.html

Errors in ./public/nlp-resources/index.html

Uh oh!

kacperlukawski commented Jun 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

vercel Bot commented Mar 5, 2026 •

edited

Loading

socket-security Bot commented Apr 29, 2026 •

edited

Loading

github-actions Bot commented Jun 23, 2026 •

edited

Loading