Skip to content
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

Sprint MartinKippenberger: Minor Improvements #1768

Open
wants to merge 44 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
7fc502d
wip1
mrnicegyu11 Oct 22, 2024
cd9bafe
Add martinKippenberger Sprint Review Draft Doc
mrnicegyu11 Oct 22, 2024
97d84ee
Add martinKippenberger Sprint Review Draft Doc -2
mrnicegyu11 Oct 22, 2024
1d3c8b0
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 22, 2024
3b46df6
Update 20241028_MartinKippenberger.md
Konohana0608 Oct 22, 2024
ba990c7
updates PC, cleanup links and md layout
pcrespov Oct 22, 2024
34ff582
updates PC
pcrespov Oct 22, 2024
2e203a9
updates PC timing and missed issues
pcrespov Oct 22, 2024
f358f1a
reduced timings and formatting
pcrespov Oct 22, 2024
c62d5b6
SAN updates
sanderegg Oct 22, 2024
8c149e4
Update 20241028_MartinKippenberger.md
wvangeit Oct 23, 2024
ba66e4e
Update 20241028_MartinKippenberger.md
jsaq007 Oct 23, 2024
2ac626e
Update 20241028_MartinKippenberger.md
odeimaiz Oct 23, 2024
296c7d5
Update 20241028_MartinKippenberger.md
odeimaiz Oct 23, 2024
5f591d3
Update 20241028_MartinKippenberger.md
YuryHrytsuk Oct 24, 2024
64b1a9a
Update 20241028_MartinKippenberger.md
YuryHrytsuk Oct 24, 2024
9653c28
Update 20241028_MartinKippenberger.md
YuryHrytsuk Oct 24, 2024
1a667ea
Update 20241028_MartinKippenberger.md
SCA-ZMT Oct 24, 2024
3743671
mag
mguidon Oct 24, 2024
a2014ff
Update 20241028_MartinKippenberger.md
matusdrobuliak66 Oct 24, 2024
8acf800
Update 20241028_MartinKippenberger.md
matusdrobuliak66 Oct 24, 2024
023f58a
SAN updates
sanderegg Oct 24, 2024
60d9250
Update 20241028_MartinKippenberger.md
odeimaiz Oct 24, 2024
0c21d69
SAN
sanderegg Oct 24, 2024
46ee23b
SAN
sanderegg Oct 24, 2024
ebb85c6
maintenance
sanderegg Oct 24, 2024
dff751a
update
sanderegg Oct 24, 2024
3d19efd
Update 20241028_MartinKippenberger.md
matusdrobuliak66 Oct 24, 2024
8a494d8
Update 20241028_MartinKippenberger.md
matusdrobuliak66 Oct 24, 2024
6a60866
IP changes
ignapas Oct 24, 2024
66c8583
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
1b783db
san
sanderegg Oct 24, 2024
d440915
Update 20241028_MartinKippenberger.md
JavierGOrdonnez Oct 24, 2024
3a7bf8c
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
e9a9c14
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
655de58
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
9d3c57c
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
2826edd
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
7248334
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
2525645
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
272c256
Update 20241028_MartinKippenberger.md
mrnicegyu11 Oct 24, 2024
bd8a2e8
ReleaseNote Improvement
mrnicegyu11 Oct 29, 2024
51de95c
ReleaseNote Improvement - 2
mrnicegyu11 Oct 29, 2024
4ecd5a4
Add v1.78.0 draft release notes - 3
mrnicegyu11 Oct 29, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions release-notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ Ask team members if it is possible to release to:

### 3. `deadlines calendar`

```
This step creates a fully formatted mattermost message, informing developers and app-team about the deadlines.
```

The following deadlines must be established (pass them in this order to the below cli):

- `prs_merge` (pull requests merge date) `usually one day before release to staging`: users have to get PRs (which must be testes by the App Team) merged in master by the end of this day
Expand All @@ -62,20 +66,23 @@ python scripts/3_deadlines_calendar.py <DATE> <DATE> <DATE> <DATE> <DATE> <DATE>

### 4. `release drafts compilation`

Ideally these are done before the review. The App Team will most likely see them only during testing.
```
This step automatically creates drafts of the release notes, one for each osparc product. A Mattermost message is also provided.
```

First, make sure your desired release version (`X.X.X`) has a draft release item on github. If there isnt one yet, please create one. Ideally these are done before the review. The App Team will most likely see them only during testing.
The email to the App Team should be sent briefly after the review is over.

Use the following script to generate the new release drafts for all the products.
A Mattermost message is also provided.
The date/time that you provide as CLI is the deadline for people to check their PRs w.r.t. the release notes.

:warning: Do not forget to commit and push the changes in the repository! :rotating_light:

```shell
python scripts/4_make_release_drafts.py <VERSION> <DATE> <TIME>
python scripts/4_make_release_drafts.py <VERSION> <DATE_DEADLINE> <TIME_DEADLINE>
```
- `<VERSION>` format: `X.X.X` where `X` is a number
- `<DATE>` format: `dd.mm` where `dd` is a valid calendar day and `mm` is valid calendar month
- `<TIME>` format: `HH.MM` where `HH` is a valid hour and `MM` is valid minute
- `<TIME>` format: `HH:MM` where `HH` is a valid hour and `MM` is valid minute


:warning: Do not forget to commit and push the changes in the repository! :rotating_light:
Expand All @@ -92,7 +99,7 @@ Ensure with the team that staging is properly deployed. Check the following:
Compose and send out email to inform the App Team when they can start testing the deployment.

```shell
python scripts/6_app_team_email.py <DATE> <DATE> <VERSION>
python scripts/6_app_team_email.py <DATE_START_TESTING> <DATE_STOP_TESTING> <VERSION>
```
- `<DATE>` format: `dd.mm` where `dd` is a valid calendar day and `mm` is valid calendar month
- `<VERSION>` format: `X.X.X` where `X` is a number
Expand Down
128 changes: 128 additions & 0 deletions reviews/20241028_MartinKippenberger.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Review Meeting - October 28, 2024

<img src="https://schema.gr/data/work/martin_kippenberger/schema_design_neon_museum_cycladic_art_martin_kippenberger_a_cry_for_freedom_exhibition_1.jpg" alt="Image" style="width:50%;">

## Sprint 🏃

- [**MartinKippenberger**](https://de.wikipedia.org/wiki/Martin_Kippenberger)
- Scrum Master: [DK]
- Happenings:
- 🚀 sim4life-lite.io 8.2beta release on October 10 2024

### Dashboards 📊

- [POs' Backlog](https://github.com/orgs/ITISFoundation/projects/15/views/14?filterQuery=has%3Arequirement+) (PM1)
- [Sprint Scrum Wall](https://github.com/orgs/ITISFoundation/projects/15/views/11) (developers' view)

### Agenda 📝

| Title | Presenter | Status | Duration | Start-Time |
| --------------------------------------------------------------------------- | ------------------------------------------- | --------------- | -------- | ---------- |
| [#1736] s4l-lite.io: Release 8.2beta | [PC] | **Done** | 3' | 10:05am |
| [#1534] Advanced Search Tool/Help Center | [IP], [JQU], [MaG] | **In progress** | 3' | 10:08am |
| [#1601] TIP: Thumbnails in Dashboard | [MEST], [DK] | **Done** | 1' | 10:11am |
| [#716] Project Folders in User Workspace (Nov.) | [OM] | **Done** | 10' | 10:12am |
| [#1408] Release Notes Improvements | [ANE] | **In progress** | 1' | 10:22am |
| [#1327] Performance Improvements for Large Projects | [SAN], [DK] | **Ongoing** | 3' | 10:23am |
| [#6411] Filesystem - Large File Handling (Caching) | [MD] | **Done** | 4' | 10:26am |
| [#1727] Filesystem - Shared Folders | [MD] | **Planned** | 0' | 10:30am |
| [#1728] Persistant Look And Feel - oSparc | [OM] | **Done** | 1' | 10:30am |
| [#1305] sim4life.io User Feedback | [IP], [JQU], [MaG] | **Ongoing** | 6' | 10:31am |
| [#1404] Sim4Life-Web dy-service versioning | [PC] | **In progress** | 3' | 10:37am |
| [#1543] Support for PHRT - Priorized Bugfixing / Enhancements | [OM] | **In progress** | 3' | 10:40am |
| [#468] Feature to undo a delete - "recycle bin" style | [PC] | **In progress** | 5' | 10:43am |
| [#1504] make s4l manual available to logged in users | [ANE], [MaG] | **In progress** | 3' | 10:48am |
| [#1406] Sim4Life Desktop+Web UI Unification | [SCA] | **Paused** | 0' | 10:51am |
| [#1314] Touchscreen + Tablet support | [JQU], | **In progress** | 5' | 10:51am |
| [#1328] Maintenance / Dev Issues | [SAN],[PC],[YH] | **Ongoing** | 8' | 10:56am |
| [#1695] sim4life web: Maintenance and Bug Fixing | [MaG] | **Ongoing** | 2' | 12:04am |
| [#1639] Portal Development | [IP] | **Ongoing** | 1' | 11:06am |
| [#1730] Hardening the computational backend | [PC] | **In progress** | 5' | 11:07am |
| [#1309] TIP v3 - osparc-devteam-tasks | [MEST], [PC] | **In progress** | 7' | 11:12am |
| [#1407] Meta-modeling: Refinements & FollowUps | [JGO], [WVG] | **In progress** | 1/3' | 11:19am |
| [#1332] NIH Year 7 | [JGO] | **Ongoing** | 1/3' | 11:19am |
| [#1597] NIH Year 8 | [JGO] | **Ongoing** | 1/3 | 11:19am |
| [#1395] App-team panel | [PC] | **In progress** | 3' | 11:20am |


[#1305]: https://github.com/ITISFoundation/osparc-issues/issues/1305
[#1309]: https://github.com/ITISFoundation/osparc-issues/issues/1309
[#1310]: https://github.com/ITISFoundation/osparc-issues/issues/1310
[#1314]: https://github.com/ITISFoundation/osparc-issues/issues/1314
[#1317]: https://github.com/ITISFoundation/osparc-issues/issues/1317
[#1326]: https://github.com/ITISFoundation/osparc-issues/issues/1326
[#1327]: https://github.com/ITISFoundation/osparc-issues/issues/1327
[#1328]: https://github.com/ITISFoundation/osparc-issues/issues/1328
[#1331]: https://github.com/ITISFoundation/osparc-issues/issues/1331
[#1332]: https://github.com/ITISFoundation/osparc-issues/issues/1332
[#1395]: https://github.com/ITISFoundation/osparc-issues/issues/1395
[#1404]: https://github.com/ITISFoundation/osparc-issues/issues/1404
[#1406]: https://github.com/ITISFoundation/osparc-issues/issues/1406
[#1407]: https://github.com/ITISFoundation/osparc-issues/issues/1407
[#1408]: https://github.com/ITISFoundation/osparc-issues/issues/1408
[#1409]: https://github.com/ITISFoundation/osparc-issues/issues/1409
[#1411]: https://github.com/ITISFoundation/osparc-issues/issues/1411
[#1504]: https://github.com/ITISFoundation/osparc-issues/issues/1504
[#1534]: https://github.com/ITISFoundation/osparc-issues/issues/1534
[#1543]: https://github.com/ITISFoundation/osparc-issues/issues/1543
[#1596]: https://github.com/ITISFoundation/osparc-issues/issues/1596
[#1597]: https://github.com/ITISFoundation/osparc-issues/issues/1597
[#1601]: https://github.com/ITISFoundation/osparc-issues/issues/1601
[#1639]: https://github.com/ITISFoundation/osparc-issues/issues/1639
[#1695]: https://github.com/ITISFoundation/osparc-issues/issues/1695
[#1727]: https://github.com/ITISFoundation/osparc-issues/issues/1727
[#1728]: https://github.com/ITISFoundation/osparc-issues/issues/1728
[#1729]: https://github.com/ITISFoundation/osparc-issues/issues/1729
[#1730]: https://github.com/ITISFoundation/osparc-issues/issues/1730
[#1732]: https://github.com/ITISFoundation/osparc-issues/issues/1732
[#1736]: https://github.com/ITISFoundation/osparc-issues/issues/1736
[#468]: https://github.com/ITISFoundation/osparc-issues/issues/468
[#6410]: https://github.com/ITISFoundation/osparc-issues/issues/6410
[#6411]: https://github.com/ITISFoundation/osparc-issues/issues/6411
[#716]: https://github.com/ITISFoundation/osparc-issues/issues/716

[ANE]:https://github.com/GitHK
[BL]:https://github.com/dyollb
[DK]:https://github.com/mrnicegyu11
[EI]:https://github.com/elisabettai
[EN]:https://github.com/esraneufeld
[GCR]:https://github.com/giancarloromeo
[IP]:https://github.com/ignapas
[JGO]:https://github.com/JavierGOrdonnez
[JQU]:https://github.com/jsaq007
[MaG]:https://github.com/mguidon
[MB]:https://github.com/bisgaard-itis
[MD]:https://github.com/matusdrobuliak66
[MEST]:https://github.com/Konohana0608
[OM]:https://github.com/odeimaiz
[PC]:https://github.com/pcrespov
[SAN]:https://github.com/sanderegg
[SB]:https://github.com/sbenkler
[SCA]:https://github.com/SCA-ZMT
[TN]:https://github.com/newton1985
[WVG]:https://github.com/wvangeit
[YH]:https://github.com/YuryHrytsuk

#### Status Legend

- _Planned_: no work done on this issue. This is the first time it apprears in a sprint.
- _Paused_: this issue was not scheduled/skipped for this sprint
- _In Progress_: this issue is still under development
- _Done_: no more work left to do on this issue. PO can review an decide to close or reopen.
- _Ongoing_: a recurrent task
- _Blocking_: prerequisits are missing

### Deployed environments 🚀

- AWS cluster (us-east-1, ZMT)
- [master_zmt](https://sim4life.io) (Testers only)
- AWS cluster (us-east-1, STRIDES)
- [staging_aws](https://staging.osparc.io) (Testers only)
- [production_aws](https://osparc.io)
- Z43 cluster (ch-zh)
- [staging_z43](http://osparc-staging.speag.com) (Testers only)
- [production_z43](http://osparc.speag.com)
- [ti-plan.itis.swiss](http://ti-plan.itis.swiss)
- [master](https://osparc-master.speag.com) (developers only)

- [Platform releases](https://github.com/ITISFoundation/osparc-simcore/releases)
60 changes: 36 additions & 24 deletions scripts/3_deadlines_calendar.py
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
import argparse
from datetime import datetime
from typing import Final

from utils import validate_date

TEMPLATE: Final[
str
] = """

## Deadlines & upcoming schedule
`{prs_merge}`: @all have all your PRs intended to be tested merged by the end of the day
`{staging_release}`: STAGING release
`{review_meeting}`: REVIEW MEETING
`{review_meeting}`: by the end of the day created draft of the release notes
`{start_app_team}`: -> {end_app_team}: App Team has exclusive access to the AWS Staging environment
`{prod_release}`: PROD release
] = """## Deadlines & upcoming schedule
{sorted_events}
Comment on lines +7 to +8
Copy link
Contributor

Choose a reason for hiding this comment

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

I find this version way less readable. I preferred the declarative template approach.

"""


def validate_date(date_str: str) -> datetime:
try:
return datetime.strptime(date_str, "%d.%m")
except ValueError:
raise argparse.ArgumentTypeError(
f"Invalid date format: '{date_str}'. Expected format is dd.mm."
)


def main() -> None:
parser = argparse.ArgumentParser(description="Assemble deadelines calendar")
parser = argparse.ArgumentParser(description="Assemble deadlines calendar")
for date in [
"prs_merge",
"staging_release",
Expand All @@ -28,22 +29,33 @@ def main() -> None:
"prod_release",
]:
parser.add_argument(
date,
type=validate_date,
help="The date is in the format dd.mm",
date, type=validate_date, help="The date is in the format dd.mm"
)
args = parser.parse_args()
print(f"\nDeadlines: {args}")

mattermost_message = TEMPLATE.format(
prs_merge=args.prs_merge,
staging_release=args.staging_release,
review_meeting=args.review_meeting,
start_app_team=args.start_app_team,
end_app_team=args.end_app_team,
prod_release=args.prod_release,
events = [
(
args.prs_merge,
"`{}`: @all have all your PRs intended to be tested merged by the end of the day",
),
(args.staging_release, "`{}`: STAGING release"),
(args.review_meeting, "`{}`: REVIEW MEETING"),
(
args.review_meeting,
"`{}`: by the end of the day created draft of the release notes",
),
(
args.start_app_team,
"`{}` -> `{}`: App Team has exclusive access to the AWS Staging environment",
),
(args.prod_release, "`{}`: PROD release"),
]
events.sort()
sorted_events = "\n".join(
event[1].format(event[0].strftime("%d.%m"), args.end_app_team.strftime("%d.%m"))
for event in events
)

mattermost_message = TEMPLATE.format(sorted_events=sorted_events)
print(f"\n{mattermost_message}\n")


Expand Down
9 changes: 7 additions & 2 deletions scripts/4_make_release_drafts.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

_MATTERMOST_TEMPLATE: str = """
@all please contribute in compiling the `Release Drafts`.
There are 3 release drafts to fill out: `s4l` (which also includes s4li-lite), `osparc`, `tip`.
There are 3 release drafts to fill out: `s4l` (which also includes s4l-lite), `osparc`, `tip`.
Instructions:
- Please go through all your last changes in master since the last release for each product: [osparc](https://github.com/ITISFoundation/osparc-issues/blob/master/release-notes/osparc/{version_tag}.md), [s4l](https://github.com/ITISFoundation/osparc-issues/blob/master/release-notes/s4l/{version_tag}.md) and [tip](https://github.com/ITISFoundation/osparc-issues/blob/master/release-notes/tip/{version_tag}.md) (each product contains a link to these changes)
- For each product please chose those features which it makes sense to highlight.
Expand Down Expand Up @@ -65,6 +65,11 @@ def _get_collpasable_notes(vtag: str) -> str:
f"https://api.github.com/repos/ITISFoundation/osparc-simcore/releases/tags/{vtag}",
timeout=10,
)
if response.status_code >= 400:
print(
f"ERROR: The GET request to the github API to https://api.github.com/repos/ITISFoundation/osparc-simcore/releases/tags/{vtag} failed. Does the github release {vtag} exist yet?"
)
exit(1)
json_response = json.loads(response.text)
return json_response["body"]

Expand Down Expand Up @@ -94,7 +99,7 @@ def main():

print("\nTotal [STEPS] 2\n")

print(f"Will generate form tag: {vtag}")
print(f"Will generate drafts for tag: {vtag}")

new_draft_content = _TEMPLATE.format(
version_tag=_get_previous_version(vtag),
Expand Down
6 changes: 4 additions & 2 deletions scripts/6_app_team_email.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,12 @@
- s4l lite https://staging.s4l-lite.io/
- s4l https://sim4life-staging.cloud/

This is the draft of the release notes: https://github.com/ITISFoundation/osparc-issues/blob/master/release-notes/s4l/{vtag}.md
This is the draft of the release notes:
- s4l https://github.com/ITISFoundation/osparc-issues/blob/master/release-notes/s4l/{vtag}.md
- tip https://github.com/ITISFoundation/osparc-issues/blob/master/release-notes/tip/{vtag}.md
Copy link
Contributor

Choose a reason for hiding this comment

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

ahh they also have to handle tip now.

We have added some highlights for you.


We would like your input on the following:
- Rewrite of the draft release notes, in a more user-friendly fashion (please make a PR back with your edits)
- Test the deployments, including the highlights if they make sense to you
Expand Down Expand Up @@ -54,7 +57,6 @@ def main() -> None:
)

print(email_content)
print("\n!!Please review and feel free to edit above text!!\n")


if __name__ == "__main__":
Expand Down