Comments (19)
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
from cortx-re.
Such an excellent idea @amolkongre !
from cortx-re.
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.
from cortx-re.
@gauravchaudhari02 @mukul-seagate11 - We can discuss on Release Notes content details here.
from cortx-re.
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.
-
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 -
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.
from cortx-re.
@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.
from cortx-re.
@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?
from cortx-re.
FYI @justinzw
from cortx-re.
Also, we will need to add to the process:
- What is the testing that happens with the new OVA?
- How do we update the link in our existing OVA quick-start-guide?
from cortx-re.
@gauravchaudhari02, Can you incorporate the same as per suggestion?
from cortx-re.
@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.
from cortx-re.
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?
from cortx-re.
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.
from cortx-re.
from cortx-re.
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?
from cortx-re.
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.
from cortx-re.
@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
from cortx-re.
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.
from cortx-re.
@gauravchaudhari02 I guess we have finalized for Release Notes. Can we close this issue.
from cortx-re.
Related Issues (20)
- CVE-2022-36087 (Medium) detected in oauthlib-3.2.1-py3-none-any.whl - autoclosed HOT 7
- Test Board-Genius Sync HOT 2
- CVE-2022-24439 (Critical) detected in GitPython-3.1.29-py3-none-any.whl HOT 1
- CVE-2022-23491 (Medium) detected in certifi-2022.9.24-py3-none-any.whl - autoclosed HOT 1
- CVE-2022-40897 (Medium) detected in setuptools-36.0.1-py2.py3-none-any.whl HOT 1
- CVE-2023-23931 (Medium) detected in cryptography-3.3.2-cp36-abi3-manylinux2010_x86_64.whl HOT 1
- CVE-2023-0286 (High) detected in cryptography-3.3.2-cp36-abi3-manylinux2010_x86_64.whl HOT 1
- CVE-2023-25577 (High) detected in Werkzeug-2.2.2-py3-none-any.whl HOT 1
- CVE-2023-23934 (Low) detected in Werkzeug-2.2.2-py3-none-any.whl HOT 1
- CVE-2023-30861 (High) detected in Flask-1.1.1-py2.py3-none-any.whl HOT 1
- Merge HW deployment code HOT 4
- Combine NODECLI and OPTIMIZED HW Deployment HOT 4
- CVE-2021-33503 (High) detected in urllib3-1.25.11-py2.py3-none-any.whl HOT 16
- cortx-all image generation instructions for community. HOT 3
- BG test HOT 4
- CVE-2021-21330 (Medium) detected in aiohttp-3.6.1-cp37-cp37m-manylinux1_x86_64.whl - autoclosed HOT 3
- CVE-2021-41496 (High) detected in numpy-1.21.5-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl - autoclosed HOT 3
- CVE-2021-34141 (Medium) detected in numpy-1.21.6-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl HOT 10
- CVE-2022-24302 (Medium) detected in paramiko-2.7.1-py2.py3-none-any.whl - autoclosed HOT 5
- Need to change our template asking for new third party software HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from cortx-re.