Skip to content

Automatically generate draft release post items from issues

James Ramsay (ex-GitLab) requested to merge better-release-post-item-drafting into master

Why is this change being made?

Drafting release posts should be fast and easy, but it is a chore for many product managers. I built a script to make them easy to generate, but it depended on familiarity with command line tools. This revisions tries to prepare the way for more substantial automation that does not require command line fluency.

Note: milestone assignment is not working because milestones are different across groups and the API does not provide a clean way to do this.

Other related improvements

How to use via scheduled GitLab CI job and labels

When an issue is ready for a release post item to be drafted, add a release post item label (e.g. 'release post item::secondary'). The script will:

  • find all issues with release post item labels the gitlab-org group
  • create draft release post items
  • commit them to unique branches
  • create a merge request and assign it to the group product manager

How to use locally

To create a draft release post item and merge request, run:

bin/release-post-item --no-local <issue-url>

Author Checklist

  • Correct MR template applied (e.g blog post)
  • Provided a concise title for the MR
  • Added a description to this MR explaining the reasons for the proposed change, per say-why-not-just-what
  • Assign this change to the correct DRI
    • If the DRI for the page/s being updated isn’t immediately clear, then assign it to your manager.
    • If your manager does not have merge rights, please ask someone to merge it AFTER it has been approved by your manager in #mr-buddies.
    • If the changes relate to any part of the project other than updates to content and/or data files please make sure to ping @gl-static-site-editor in a comment for a review and merge. For example changes to .gitlab-ci.yml, JavaScript/CSS/Ruby code or the layout files.

For help with failing pipelines reach out in #mr-buddies in Slack

Edited by James Ramsay (ex-GitLab)

Merge request reports