Owner: Architect:

David Peraza

Story (Required)

As a Sample Developer I will like to be able to create messages for library owners but also update via comment and close if needed, so that I can automatically manage the lifecycle of the communication.

Background (Required)

We currently have a workflow that gets trigger manually. It has automation to create issues on the library repos. However, we need to also be able to update (comments, new target repos) and be able to close issues when not needed anymore.

Glossary

NA

Out of scope

NA

In Scope

NA

Approach(Required)

Lets do something like this:

1. Define a message directory and a state directory
2. Define a message as a yaml file that contains the structure of a github issue (Title, Description, Comments) but also the recipient types (template, image streams, all, none)
3. A PR to create such message file will trigger workflow to send github issues to the recipients (library repos) but will also append a message ID to the message YAML before merging.
4. The state file will be another yaml, matching the message ID and a link to all the issues already created.
5. We will never allow changes to title and description and recipient type. Only comments will be allowed. to the same.
6. The comments field is a list and user will be able to add comments based on the msg id.
7. There will be a new msg file for every new cause/purpose and there will be a state file corresponding to it
8. We will never allow for a message to be deleted, only change recipient type to none.
9. There will be a flag if in case we wish to close the issue

Demo requirements(Required)

A great demo will show how we can add update and close issue for library repos.

Dependencies

NA

Edge Case

NA

Acceptance Criteria

I can send a message PR to create new issue
I can update a message PR with comments and recipient type
I can close all issue by setting recipient type to none
I have created a demo that shows create update and close

Documentation: No

Release Notes Type: NA

INVEST Checklist

Dependencies identified

Blockers noted and expected delivery timelines set

Design is implementable

Acceptance criteria agreed upon

Story estimated

v

Legend

Unknown

Verified

Unsatisfied