Skip to content

chore: Add product update templates #825

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Sep 6, 2024
Merged

Conversation

NickLarsenNZ
Copy link
Member

@NickLarsenNZ NickLarsenNZ commented Sep 5, 2024

Description

Note

This started out as PR templates, but we need to be able to create them ahead of code changes.

These have been broken up from the old template which has the following problems:

  • It covers every product in one issue, meaning the issue stays open for a long time and progress is difficult to visualise on the engineering board.
  • Concurrent updates to the issue description across the team is buggy (eg: old changes reverted and replaced by new changes. Sometimes the description becomes locked as a result.
  • Improving instructions on the old template means the description becomes even longer.

This change:

  • Refactor the pre-release tracking issue with links to quickly create the issues from these templates.
  • Splits up the product update issue templates per product or product group for easier tracking on the engineering board.
  • Automatically adds issues to the engineering project board
  • There are specific instructions per-product to help the person doing the updates work autonomously. These aren't perfect, but can be improved over time.

To consider:

  • hello-world Added in a tasklist in pre-release for now
  • krb5 Added in a tasklist in pre-release for now
  • tools (and other misc items) Added in a tasklist in pre-release for now
  • Moving ubi*-rust-builders out of the release process (they can be done as needed by developers or when SecObserve/Renovate recommend it).
  • Revamping the existing PR template
  • Issue template for tasks when adding a new product/base

Note: These instructions are not perfect, and should be improved over time.
This is because there are tracked items that can only be completed after the PR is merged. Issue templates are a little easier to use, and do not need a code change to be able to use them.
@NickLarsenNZ NickLarsenNZ self-assigned this Sep 5, 2024
…m products

Note: This helps when generating links, where we sort (the bases will appear before products).
Copy link
Member

@adwk67 adwk67 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@NickLarsenNZ NickLarsenNZ added this pull request to the merge queue Sep 6, 2024
Merged via the queue into main with commit 5743664 Sep 6, 2024
2 checks passed
@NickLarsenNZ NickLarsenNZ deleted the product-update-templates branch September 6, 2024 13:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants