Skip to content

Release Post Generator not carrying over images from issue descriptions

The Release Post Generator is no longer automatically extracting and including images from the source issue/epic descriptions when creating release post items. This creates additional manual work for contributors who have to manually add images after the release post item is generated.

Current behavior When running the Release Post Generator on an issue/epic that contains images in its description, the generated release post item:

  • Creates a placeholder image path: /images/unreleased/REPLACE_THIS_WITH_THE_IMAGE_PATH.png (for primary items)
  • Does not download or include the actual images from the issue description
  • Requires manual intervention to add the images

Expected behavior The Release Post Generator should:

  • Parse the issue/epic description for images
  • Download those images automatically
  • Save them to the appropriate /images/unreleased/ directory
  • Update the image_url field in the YAML file with the correct path

Example See !140920 (merged) where images had to be manually added after the release post item was generated, despite the source issue containing images.

Technical details

  1. The code in lib/release_post/post_entry.rb has logic for handling images:
  2. image_path method generates the image file path
  3. image_commit_action method attempts to create image commits
  4. The Issue class appears to have image_url and image_base64 properties

However, it seems the image extraction from the issue description is not working properly.

Investigation

It looks like it didn't work in the case of gitlab-org/gitlab#556200 (closed) because it's a task, not an issue or epic.

More specifically:

Release Post Generator: Only supports traditional issues and epics via the API endpoints:

  • https://gitlab.com/api/v4/groups/9970/issues
  • https://gitlab.com/api/v4/groups/9970/epics

Currently, there is no support for work_items.

Edited by Cynthia "Arty" Ng