Release Notes for OVA 1.0.4 release. about cortx-re

[amolkongre]

Once our JIRA-GITHUB ISSUES bridge works.... In the OVA Release note, instead of mentioning EOS-Ticket# we can create its clone in Github Issue and can give those ticket nos, so that details will be visible to open community as well

[johnbent]

Such an excellent idea @amolkongre !

[stale]

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @shailesh-vaidya for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

[shailesh-vaidya]

@gauravchaudhari02 @mukul-seagate11 - We can discuss on Release Notes content details here.

[gauravchaudhari02]

I have raised a PR #195 for automation script of ova-release on every sprint end.
Below are two example releases generated automatically by script.

1. It is generated with release-notes having JIRA id and some tasks (like estimation, planning, study tasks) which should not be under feature section.
   https://github.com/gauravchaudhari02/cortx/releases/tag/1.0.0

2. It is a release with added semantic versioning and release-notes with no JIRA id,filter-issue option where we can filter out issues for estimation, planning and other keywords.
   https://github.com/gauravchaudhari02/cortx/releases/tag/VA-1.0.3

@johnbent @amolkongre @shailesh-vaidya @mukul-seagate11 @gowthamchinna, Could you please have a look at these releases and suggest if we can do it better? let me know your thoughts or approach towards automated release.

[johnbent]

@gregnsk will be interested in this. As will Praveen but I can't remember his github ID right now to tag him. This is great progress @gauravchaudhari02 . Let me take a look.

[johnbent]

@gauravchaudhari02 , I think I prefer the one without the JIRA ID since the community can't see JIRA. However, it is useful to have the JIRA ID so our engineering team can quickly look things up if the community has questions. In the community one, could you add the JIRA ID in brackets after the item? Like so:
s3server R2 planning [Seagate internal ID EOS-16029]
and have 'EOS-16029' be an actual link to the internal system? I would be OK with the community seeing that and then we ourselves could use it for quick exploration.

Also, I also love automation but I think it would be better with 3 sections instead of 2. Right now it has
Features
Bugfixes

It would be much better if it had a third section:
Highlights
list of easily understandable items which we are excited to tell the community about
Features
as is [with the addition as described above]
Bugfixes
as is [with the addition as described above]

@gauravchaudhari02 , how can we most easily add that Highlights section?

FYI @pviraraghavan and @novium258 . @novium258 , this will be perfect fodder for our monthly newsletter.

@gauravchaudhari02 , this will be going into our releases in our parent repo right?

[johnbent]

FYI @justinzw

[johnbent]

Also, we will need to add to the process:

1. What is the testing that happens with the new OVA?
2. How do we update the link in our existing OVA quick-start-guide?

[mukul-seagate11]

@gauravchaudhari02, Can you incorporate the same as per suggestion?

[gauravchaudhari02]

@gauravchaudhari02 , how can we most easily add that Highlights section?

One way is to pass an array of tickets e.g. --highlight [EOS-1234, EOS-3456] to script for highlight section or we need to add [Highlight] word before a ticket name while creating ticket so we can filter tickets based on word Highlight and create a separate section.

@gauravchaudhari02 , this will be going into our releases in our parent repo right?

Yes

How do we update the link in our existing OVA quick-start-guide?

We can tag a release as latest and access it using releases/latest URL.
for more info - https://docs.github.com/en/github/administering-a-repository/linking-to-releases

@gauravchaudhari02, Can you incorporate the same as per suggestion?

Added a new release as per comments.
https://github.com/gauravchaudhari02/cortx/releases/tag/VA-1.0.4

@johnbent @shailesh-vaidya @mukul-seagate11, let me know if we can adhere to a better approach than this.

[johnbent]

Looks good to me. We also need a person assigned for @novium258 to work with if she thinks the 'Highlights' section is not suitably intuitive and needs manual editing. Who can that person be?

[gauravchaudhari02]

Looks good to me. We also need a person assigned for @novium258 to work with if she thinks the 'Highlights' section is not suitably intuitive and needs manual editing. Who can that person be?

@johnbent, Anyone of us with admin access can edit a release and its contents. If we want something to be implemented automatically, I would be a contact person.

furthermore, which way to finalize for highlights section from below options?

One way is to pass an array of tickets e.g. --highlight [EOS-1234, EOS-3456] to script for highlight section or we need to add [Highlight] word before a ticket name while creating ticket so we can filter tickets based on word Highlight and create a separate section.

[johnbent]

Anyone of us can edit. But imagine this scenario please: 1. A release is published 2. The Highlights look like this: * Now foo can connect to the bar * The garply and the plugh now xxywy 3. Rachel needs someone to help her translate those into intuitive English 4. Who can be responsible to work as an intermediary between Rachel and engineering team to get this translation? 5. Once we have it, then any of us can edit the release * I agree that's the easy bit. 🙂

…

________________________________ From: Gaurav Chaudhari <[email protected]> Sent: Tuesday, January 19, 2021 3:26 AM To: Seagate/cortx-re <[email protected]> Cc: John Bent <[email protected]>; Mention <[email protected]> Subject: Re: [Seagate/cortx-re] Release Notes for OVA release. (#182) Looks good to me. We also need a person assigned for @novium258<https://github.com/novium258> to work with if she thinks the 'Highlights' section is not suitably intuitive and needs manual editing. Who can that person be? @johnbent<https://github.com/johnbent>, Anyone of us with admin access can edit a release and its contents. If we want something to be implemented automatically, I would be a contact person. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<#182 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAPT2PRVYCNOBMOXLOEO63DS2VM57ANCNFSM4VZ5YQDA>.

[gauravchaudhari02]

Anyone of us can edit.  But imagine this scenario please:
  1.  A release is published
  2.  The Highlights look like this:
     *   Now foo can connect to the bar
     *   The garply and the plugh now xxywy
  3.  Rachel needs someone to help her translate those into intuitive English
  4.  Who can be responsible to work as an intermediary between Rachel and engineering team to get this translation?
  5.  Once we have it, then any of us can edit the release
     *   I agree that's  the easy bit.  🙂 

@mukul-seagate11, Could you please comment here for an intermediary between Rachel and engineering team? Would it be Venkat or Saumya?

[stale]

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @shailesh-vaidya for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

[gauravchaudhari02]

@shailesh-vaidya, Can we finalize the format of issues for an automated release-notes generation? So, we can merge the PR with the final format.
Latest format - component_name : issue_description

[stale]

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @shailesh-vaidya for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

[shailesh-vaidya]

@gauravchaudhari02 I guess we have finalized for Release Notes. Can we close this issue.