Skip to content

CLOUDP-296909: Add some comments to the IPA release workflow #390

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.

Sign up for GitHub

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
lovisaberggren merged 1 commit into from
Jan 27, 2025
Merged

CLOUDP-296909: Add some comments to the IPA release workflow #390

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions .github/workflows/release-IPA-metrics.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# This workflow will generate metrics about the IPA validation on the current OAS
# (number of adoptions, violations and exceptions) and upload the data to an S3 bucket.
name: IPA Validation Metrics Release
on:
workflow_call:
Expand All @@ -21,6 +23,8 @@ permissions:
issues: write

jobs:
# Checks the last workflow run, and decides whether the IPA release metrics should be uploaded or
# skipped. The release-IPA-metrics job only runs if the last release was not today and did not fail.
pre-IPA-metrics-release-checks:
Comment on lines +26 to 28
Copy link
Collaborator

@andreaangiolillo andreaangiolillo Jan 27, 2025

Choose a reason for hiding this comment

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

Do you have a Jira ticket where you plan to run the workflow as part of the release process? Btw, you could just update this workflow to run automatically when a specific file is updated on the master branch

on:
  push:
    paths:
      - openapi/v2.json

Copy link
Collaborator Author

@lovisaberggren lovisaberggren Jan 27, 2025

Choose a reason for hiding this comment

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

We have already added it here: #388

Btw, you could just update this workflow to run automatically when a specific file is updated on the master branch

That could be an option, though this file corresponds to the prod oas right? Since we wanted to get the metrics from the dev oas I think we need to do it during the dev oas release

Copy link
Collaborator

@andreaangiolillo andreaangiolillo Jan 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

We have already added it here

Ah okay, I missed it. I am still of the opinion that you don't need to add it to the release workflow as this makes it more complex🤔 IMO the easiest approach would be to run the workflow once a day (end of the day) and file an issue on the repo if the push fails. The Foas Release process is getting more and more complex + this approach forces us to run this workflow multiple times per day (~every hour if the spec has changed on master) while we just need to run it once.

No need to address anything here, it is more me thinking loud.

Copy link
Collaborator Author

@lovisaberggren lovisaberggren Jan 27, 2025

Choose a reason for hiding this comment

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

Yeah I see your point, it's something we can consider as an improvement perhaps during the new epic IPA: validations applied, or as a follow up during a non-epic week, CC: @yelizhenden-mdb

name: IPA Metrics Release Pre-Checks
runs-on: ubuntu-latest
Expand All @@ -43,6 +47,7 @@ jobs:
})
return shouldRunRelease

# Generates and uploads the IPA validation metrics to S3
release-IPA-metrics:
name: Release IPA Validation Metrics
needs: [pre-IPA-metrics-release-checks]
Expand Down
Loading