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.

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

Jump to bottom

Prevent concurrency between release app and draft releases #4506

Merged
merged 1 commit into from
Jun 18, 2024
Merged

Prevent concurrency between release app and draft releases #4506

merged 1 commit into from
Jun 18, 2024

Conversation

sarayourfriend
Copy link
Contributor

Fixes

Fixes #4505 by @sarayourfriend

Description

Prevent concurrency between these workflows by putting them in the same concurrency group (GitHub docs). This means they will never run at the same time, and will queue until previous runs of either workflow are finished.

The "draft releases" workflow is very fast (< 1 minute, often around 30 seconds), so this will not add a big delay to "release app" (and therefore production deployments).

Testing Instructions

Confirm I've got the syntax right and my understanding of GitHub's concurrency groups is correct (refer to docs link above).

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (just catalog/generate-docs for catalog
    PRs) or the media properties generator (just catalog/generate-docs media-props
    for the catalog or just api/generate-docs for the API) where applicable.

Developer Certificate of Origin

Developer Certificate of Origin 
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.
@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Jun 17, 2024
@sarayourfriend sarayourfriend requested a review from a team as a code owner June 18, 2024 00:00
@openverse-bot openverse-bot added the 💻 aspect: code Concerns the software code in the repository label Jun 18, 2024
AetherUnbound
AetherUnbound approved these changes Jun 18, 2024
View reviewed changes
Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

One note on this: it looks like we were dividing the release app workflow into separate runs based on the service being released. The new group is entirely independent of that, which means we won't be able to run those releases concurrently. That's probably fine and would be rare anyway, but worth pointing out.
@sarayourfriend
Copy link
Contributor Author

Yes, it's mentioned in the issue:

To implement the fix, use the same concurrency key for the two workflows. This will mostly be a big change to release app, which will now not be able to handle multiple apps at once. That's fine, really. Let them queue. We never need to move that fast.
@AetherUnbound
Copy link
Contributor

Ahh, thanks. I hadn't seen the issue before reviewing this.
zackkrida
zackkrida approved these changes Jun 18, 2024
View reviewed changes
Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

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

It's nice to leave behind the startsWith concurrency logic as a bonus; lgtm.
@AetherUnbound AetherUnbound merged commit 0756487 into main Jun 18, 2024
74 checks passed
@AetherUnbound AetherUnbound deleted the fix/prevent-release-and-draft-concurrency branch June 18, 2024 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🤖 aspect: dx Concerns developers' experience with the codebase 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: mgmt Related to repo management and automations
4 participants
@sarayourfriend @AetherUnbound @zackkrida @openverse-bot