Skip to content

Conversation

@achave11-ucsc
Copy link
Member

@achave11-ucsc achave11-ucsc commented Sep 29, 2025

Linked issue: #7409

Checklist

Author

  • PR is assigned to the author
  • Target branch is develop
  • Name of PR branch matches upgrades/yyyy-mm-dd
  • PR is linked to the upgrade issue it resolves
  • PR title matches Upgrade dependencies yyyy-mm-dd
  • PR title references the linked issue

Author (upgrading deployments)

  • Ran make docker_images.json and committed the resulting changes or this PR does not modify azul_docker_images, or any other variables referenced in the definition of that variable
  • Documented upgrading of deployments in UPGRADING.rst or this PR does not require upgrading deployments
  • Added u tag to commit title or this PR does not require upgrading deployments
  • This PR is labeled upgrade or does not require upgrading deployments
  • This PR is labeled deploy:shared or does not modify docker_images.json, and does not require deploying the shared component for any other reason
  • This PR is labeled deploy:gitlab or does not require deploying the gitlab component
  • This PR is labeled backup:gitlab
  • This PR is labeled deploy:runner or does not require deploying the runner image

Author (before every review)

  • Rebased PR branch on develop, squashed fixups from prior reviews
  • Ran make requirements_update or this PR does not modify requirements*.txt, common.mk, Makefile, Dockerfile or environment.boot
  • Added R tag to commit title or this PR does not modify requirements*.txt
  • This PR is labeled reqs or does not modify requirements*.txt
  • make integration_test passes in personal deployment or this PR does not modify functionality that could affect the IT outcome
  • PR is not a draft
  • PR is awaiting requested review from system administrator
  • Status of PR is Review requested
  • PR is assigned to only the system administrator

System administrator (after approval)

  • Actually approved the PR
  • Labeled linked issue as no demo
  • A comment to this PR details the completed security design review
  • PR title is appropriate as title of merge commit
  • Status of PR is Approved
  • PR is assigned to only the operator

Operator

  • Squashed PR branch and rebased onto develop
  • Sanity-checked history
  • Pushed PR branch to GitHub

Operator (deploy .shared and .gitlab components)

  • Ran _select dev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unused or this PR is not labeled deploy:shared
  • Ran _select dev.gitlab && python scripts/create_gitlab_snapshot.py --no-restart (see operator manual for details) or this PR is not labeled backup:gitlab
  • sshd fails to start in GitLab 18.0.2 container #7218 (comment)
  • Ran _select dev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab apply or this PR is not labeled deploy:gitlab
  • Undo removal of workaround and repeat the previous action
  • Ran _select anvildev.shared && CI_COMMIT_REF_NAME=develop make -C terraform/shared apply_keep_unused or this PR is not labeled deploy:shared
  • Ran _select anvildev.gitlab && python scripts/create_gitlab_snapshot.py --no-restart (see operator manual for details) or this PR is not labeled backup:gitlab
  • Ran _select anvildev.gitlab && CI_COMMIT_REF_NAME=develop make -C terraform/gitlab apply or this PR is not labeled deploy:gitlab
  • Checked the items in the next section or this PR is labeled deploy:gitlab
  • PR is assigned to only the system administrator or this PR is not labeled deploy:gitlab

System administrator (post-deploy of .gitlab component)

  • Background migrations for dev.gitlab are complete or this PR is not labeled deploy:gitlab
  • Background migrations for anvildev.gitlab are complete or this PR is not labeled deploy:gitlab
  • PR is assigned to only the operator

Operator (deploy runner image)

  • Ran _select dev.gitlab && make -C terraform/gitlab/runner or this PR is not labeled deploy:runner
  • Ran _select anvildev.gitlab && make -C terraform/gitlab/runner or this PR is not labeled deploy:runner

Operator (sandbox build)

  • Added sandbox label
  • Pushed PR branch to GitLab dev
  • Pushed PR branch to GitLab anvildev
  • Build passes in sandbox deployment
  • Build passes in anvilbox deployment
  • Reviewed build logs for anomalies in sandbox deployment
  • Reviewed build logs for anomalies in anvilbox deployment

Operator (merge the branch)

  • All status checks passed and the PR is mergeable
  • The title of the merge commit starts with the title of this PR
  • Added PR # reference to merge commit title
  • Collected commit title tags in merge commit title but excluded any p tags
  • Closed related Dependabot PRs with a comment referencing the corresponding commit in this PR or this PR does not include any such commits
  • Pushed merge commit to GitHub
  • Status of PR is Merged lower
  • Status of blocked issues is Triage or no issues are blocked on the linked issue

Operator (main build)

  • Pushed merge commit to GitLab dev
  • Pushed merge commit to GitLab anvildev
  • Build passes on GitLab dev
  • Reviewed build logs for anomalies on GitLab dev
  • Build passes on GitLab anvildev
  • Reviewed build logs for anomalies on GitLab anvildev
  • Ran _select dev.shared && make -C terraform/shared apply or this PR is not labeled deploy:shared
  • Ran _select anvildev.shared && make -C terraform/shared apply or this PR is not labeled deploy:shared
  • Deleted PR branch from GitHub
  • Deleted PR branch from GitLab dev
  • Deleted PR branch from GitLab anvildev
  • Status of linked issue is Lower

Operator

  • At least 24 hours have passed since anvildev.shared was last deployed
  • Ran scripts/export_inspector_findings.py against anvildev, imported results to Google Sheet and posted screenshot of relevant1 findings as a comment on the linked issue.
  • Propagated the deploy:shared, deploy:gitlab, deploy:runner and backup:gitlab labels to the next promotion PRs or this PR carries none of these labels
  • Propagated any specific instructions related to the deploy:shared, deploy:gitlab, deploy:runner and backup:gitlab labels, from the description of this PR to that of the next promotion PRs or this PR carries none of these labels
  • PR is assigned to only the system administrator

1A relevant finding is a high or critical vulnerability in an image
that is used within the security boundary. Images not used within the boundary
are tracked in azul.docker_images under a key starting with _.

System administrator

  • No currently reported vulnerability requires immediate attention
  • PR is assigned to no one

Shorthand for review comments

  • L line is too long
  • W line wrapping is wrong
  • Q bad quotes
  • F other formatting problem

@achave11-ucsc achave11-ucsc self-assigned this Sep 29, 2025
@achave11-ucsc achave11-ucsc added reqs [process] PR includes commit requiring ``make requirements`` deploy:gitlab [process] PR requires deploying `gitlab` component deploy:shared [process] PR requires deploying `shared` component backup:gitlab [process] PR requires backing up GitLab instances deploy:runner [process] PR requires deploying `runner` component labels Sep 29, 2025
@coveralls
Copy link

coveralls commented Sep 29, 2025

Coverage Status

coverage: 85.438%. remained the same
when pulling d112f7d on upgrades/2025-09-15
into 5dbe828 on develop.

@codecov
Copy link

codecov bot commented Sep 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.20%. Comparing base (5dbe828) to head (d112f7d).
⚠️ Report is 6 commits behind head on develop.

Additional details and impacted files
@@           Coverage Diff            @@
##           develop    #7447   +/-   ##
========================================
  Coverage    85.20%   85.20%           
========================================
  Files          155      155           
  Lines        22334    22334           
========================================
  Hits         19029    19029           
  Misses        3305     3305           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@achave11-ucsc achave11-ucsc linked an issue Sep 29, 2025 that may be closed by this pull request
32 tasks
@hannes-ucsc hannes-ucsc removed the orange label Oct 2, 2025
run();
});
}
</script>
Copy link
Member

Choose a reason for hiding this comment

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

A large deletion like this should have raised concerns. This is not a trivial update. More importantly, if you update this file, you would need to update our templatized copy of it, too. Please re-read the operator manual section on Swagger UI updates. It mentions both concerns, non-trivial updates and the templates.

Copy link
Member Author

Choose a reason for hiding this comment

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

Created #7468.


repository_url = 'https://raw.githubusercontent.com/swagger-api/swagger-ui'
tag = 'v5.27.1'
tag = 'v5.29.1'
Copy link
Member

Choose a reason for hiding this comment

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

Please investigate as to why we skipped these intermediate versions:

CleanShot 2025-10-03 at 09 25 39@2x

Copy link
Member Author

Choose a reason for hiding this comment

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

Discussed during PL.

@hannes-ucsc hannes-ucsc added the 1 review [process] Lead requested changes once label Oct 3, 2025
@achave11-ucsc
Copy link
Member Author

Changes in Swagger up to version v5.28.1 from our last updated version:

Features:

Bug Fixes:

With a combined total of 9 lines changed.

Copy link
Member

@hannes-ucsc hannes-ucsc left a comment

Choose a reason for hiding this comment

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

Another way to show that the upgrade does not affect the dist directory is to show the history of only that directory:

https://github.com/swagger-api/swagger-ui/commits/master/dist

CleanShot 2025-10-06 at 22 55 17@2x

It does not mention the version we upgrade from or the version we upgrade to.

@hannes-ucsc
Copy link
Member

Security design review

  • Security design review completed; this PR does not
    • … affect authentication; for example:
      • OAuth 2.0 with the application (API or Swagger UI)
      • Authentication of developers with Google Cloud APIs
      • Authentication of developers with AWS APIs
      • Authentication with a GitLab instance in the system
      • Password and 2FA authentication with GitHub
      • API access token authentication with GitHub
      • Authentication with Terra
    • … affect the permissions of internal users like access to
      • Cloud resources on AWS and GCP
      • GitLab repositories, projects and groups, administration
      • an EC2 instance via SSH
      • GitHub issues, pull requests, commits, commit statuses, wikis, repositories, organizations
    • … affect the permissions of external users like access to
      • TDR snapshots
    • … affect permissions of service or bot accounts
      • Cloud resources on AWS and GCP
    • … affect audit logging in the system, like
      • adding, removing or changing a log message that represents an auditable event
      • changing the routing of log messages through the system
    • … affect monitoring of the system
    • … introduce a new software dependency like
      • Python packages on PYPI
      • Command-line utilities
      • Docker images
      • Terraform providers
    • … add an interface that exposes sensitive or confidential data at the security boundary
    • … affect the encryption of data at rest
    • … require persistence of sensitive or confidential data that might require encryption at rest
    • … require unencrypted transmission of data within the security boundary
    • … affect the network security layer; for example by
      • modifying, adding or removing firewall rules
      • modifying, adding or removing security groups
      • changing or adding a port a service, proxy or load balancer listens on
  • Documentation on any unchecked boxes is provided in comments below

@dsotirho-ucsc dsotirho-ucsc added the sandbox [process] Resolution is being verified in sandbox deployment label Oct 8, 2025
@dsotirho-ucsc dsotirho-ucsc merged commit 5d9161b into develop Oct 8, 2025
10 checks passed
@dsotirho-ucsc dsotirho-ucsc deleted the upgrades/2025-09-15 branch October 8, 2025 17:59
@achave11-ucsc achave11-ucsc removed their assignment Oct 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 review [process] Lead requested changes once backup:gitlab [process] PR requires backing up GitLab instances deploy:gitlab [process] PR requires deploying `gitlab` component deploy:runner [process] PR requires deploying `runner` component deploy:shared [process] PR requires deploying `shared` component reqs [process] PR includes commit requiring ``make requirements`` sandbox [process] Resolution is being verified in sandbox deployment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Upgrade dependencies 2025-09-15

5 participants