Update docs on using concurrency to auto-cancel redundant jobs / runs by mnquintana · Pull Request #11244 · github/docs

mnquintana · 2021-10-17T18:52:32Z

Why:

This PR updates the docs on using concurrency to cancel in-progress jobs / runs to provide examples that scope this behavior to a workflow. The new examples should make it possible for users to approximate the behavior other CI providers give you out of the box for auto-canceling redundant jobs / runs on a PR, without running into all the pitfalls I did that resulted in a long GitHub Support thread. 😅

Reference

To reference the behavior other CI providers document:

What's being changed:

The Workflow syntax for GitHub Actions page, concurrency section

Check off the following:

I have reviewed my changes in staging (look for the latest deployment event in your pull request's timeline, then click View deployment).
For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

This pull request impacts the contribution experience
- I have added the 'writer impact' label
- I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

welcome · 2021-10-17T18:52:33Z

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

mnquintana · 2021-10-17T19:07:29Z

+{% raw %}
+```yaml
+concurrency: 
+ group: ${{github.workflow}}-${{ github.head_ref }}


Is github.workflow guaranteed to be unique in a repository with multiple workflows? I wasn't 100% sure from looking at the context docs.

Choghi · 2021-10-18T01:35:38Z

Thanks

ramyaparimi · 2021-10-18T12:50:41Z

@mnquintana
Thanks so much for opening a PR! I'll get this triaged for review ⚡

lee-dohm · 2021-10-18T18:58:53Z

👋 Good to see you again @mnquintana. Thanks so much for the detailed and well-thought-out PR 🙇‍♂️

mnquintana · 2021-10-18T20:38:10Z

Hey good to see you too @lee-dohm! Thanks so much for giving this a look 🙇🏽

mnquintana · 2021-10-19T16:05:28Z

Hmmm looks like the deploy is failing – not sure if that's something I did or if a maintainer just needs to re-run the workflow

ramyaparimi · 2021-10-19T18:58:53Z

@mnquintana Thank you for the message!! Definitely nothing you did 💖 The staging build and deploy workflows are temporarily disabled 💛

github-actions · 2021-10-27T16:56:38Z

A stale label has been added to this pull request because it has been open 7 days with no activity. To keep this PR open, add a comment or push a commit within 3 days.

mnquintana · 2021-10-27T17:25:13Z

Adding a comment to keep the stale bot at bay 👀

mnquintana · 2021-11-08T16:26:08Z

@ramyaparimi @lee-dohm 👋🏽 Just checking in – any updates on a review for this one? 🙇🏽

lee-dohm · 2021-11-09T17:49:52Z

My apologies @mnquintana! Between Universe and my being on vacation last week, this fell behind. I'll get it in front of the right people and get back to you!

martin389 · 2021-11-11T23:42:25Z

Thanks for this PR! I'm working on getting this reviewed now 👍

mnquintana · 2021-11-22T17:12:33Z

@martin389 👋🏽 Just checking in – any updates on getting this PR reviewed? 🙇🏽

martin389 · 2021-11-22T22:19:37Z

Status update: I've found someone who can review this work, and its now in their queue 👍

mnquintana · 2021-12-01T18:18:53Z

@martin389 👋🏽 Just checking in again - any chance of getting this PR reviewed this week? 🙇🏽

martin389 · 2021-12-02T07:09:24Z

Status update: Following up with reviewers 👀

martin389 · 2021-12-16T00:29:21Z

Unassigning myself so that the tech reviewer can take this.

mnquintana · 2022-01-12T19:30:48Z

Happy New Year! Are there any plans to ever review this PR? 3 months for a content review seems a bit extreme.

ramyaparimi · 2022-01-13T17:40:08Z

@mnquintana You’re absolutely right. I apologize for how long this has taken, three months is completely out of line with our expectations for ourselves. We appreciate the patience and understanding you’ve shown thus far. I’m going to talk to the team and find out how we can get this resolved as soon as possible.
Stay tuned!

skedwards88

This PR adds great examples! Thank you for taking the time to share your knowledge (and thank you for your patience waiting for a review). I made some suggestions that I will go ahead and incorporate, then I'll get this merged down for you.

github-actions · 2022-01-13T19:40:03Z

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Update docs on using concurrency to auto-cancel in-progress runs
c5c59f0

mnquintana commented Oct 17, 2021
View reviewed changes

This comment has been minimized.

mnquintanaand others added 2 commits October 19, 2021 13:08

Merge branch 'main' into mnquintana/concurrency
ca79716

Merge branch 'main' into mnquintana/concurrency
46409b3

github-actionsBot added the stale There is no recent activity on this issue or pull request label Oct 27, 2021

ramyaparimi added waiting for review Issue/PR is waiting for a writer's review and removed stale There is no recent activity on this issue or pull request needs content strategy Wait to open a PR until there's an approved content strategy in the issue labels Oct 28, 2021

Fix spacing in examples
382d53f

martin389 assigned martin389 and unassigned martin389 Nov 10, 2021

Merge branch 'main' into mnquintana/concurrency
df2a471

Martin Lopes added 2 commits December 3, 2021 09:51

Merge branch 'main' into mnquintana/concurrency
c9a8c81

Merge branch 'main' into mnquintana/concurrency
2cddece

martin389 removed their assignment Dec 16, 2021

ramyaparimi added the actions This issue or pull request should be reviewed by the docs actions team label Jan 13, 2022

Merge branch 'main' into mnquintana/concurrency
0d660c9

skedwards88 reviewed Jan 13, 2022
View reviewed changes

Apply suggestions from code review
68261ca

skedwards88 reviewed Jan 13, 2022
View reviewed changes

Comment threaddata/reusables/actions/actions-group-concurrency.md Outdated

Apply suggestions from code review
a3d9c37

skedwards88 previously approved these changes Jan 13, 2022
View reviewed changes

skedwards88 dismissed their stale review via a3d9c37January 13, 2022 19:33

Merge branch 'main' into mnquintana/concurrency
9739aad

skedwards88 added the ready to merge This pull request is ready to merge label Jan 13, 2022

skedwards88 approved these changes Jan 13, 2022
View reviewed changes

skedwards88 enabled auto-merge (squash) January 13, 2022 19:35

skedwards88 merged commit 7ae281c into github:mainJan 13, 2022

snyk-bot mentioned this pull request Jul 15, 2022
[Snyk] Upgrade webpack from 4.44.0 to 4.46.0 venkatarao-palaparthi/docs#291
Open

YoYBaBy mentioned this pull request Jul 15, 2022
[Snyk] Upgrade webpack from 4.44.0 to 4.46.0 YoYBaBy/docs#559
Open

YoYBaBy mentioned this pull request Oct 27, 2023
[Snyk] Upgrade webpack from 4.44.0 to 4.47.0 YoYBaBy/docs#733
Open

ashly1111111 mentioned this pull request Oct 27, 2023
[Snyk] Upgrade webpack from 4.44.0 to 4.47.0 ashly1111111/docs#88
Open

YoYBaBy mentioned this pull request Dec 18, 2023
[Snyk] Upgrade webpack from 4.44.0 to 4.47.0 YoYBaBy/docs#760
Open

Uh oh!

Conversation

mnquintana commented Oct 17, 2021

Why:

Reference

What's being changed:

Check off the following:

Writer impact (This section is for GitHub staff members only):

Uh oh!

welcomeBot commented Oct 17, 2021

Uh oh!

mnquintanaOct 17, 2021

Choose a reason for hiding this comment

Uh oh!

Choghi commented Oct 18, 2021

Uh oh!

ramyaparimi commented Oct 18, 2021

Uh oh!

lee-dohm commented Oct 18, 2021

Uh oh!

mnquintana commented Oct 18, 2021

Uh oh!

mnquintana commented Oct 19, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ramyaparimi commented Oct 19, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actionsBot commented Oct 27, 2021

Uh oh!

mnquintana commented Oct 27, 2021

Uh oh!

mnquintana commented Nov 8, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

lee-dohm commented Nov 9, 2021

Uh oh!

martin389 commented Nov 11, 2021

Uh oh!

mnquintana commented Nov 22, 2021

Uh oh!

martin389 commented Nov 22, 2021

Uh oh!

mnquintana commented Dec 1, 2021

Uh oh!

martin389 commented Dec 2, 2021

Uh oh!

martin389 commented Dec 16, 2021

Uh oh!

mnquintana commented Jan 12, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ramyaparimi commented Jan 13, 2022

Uh oh!

skedwards88 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actionsBot commented Jan 13, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

mnquintana commented Oct 19, 2021•
edited
Loading

ramyaparimi commented Oct 19, 2021•
edited
Loading

mnquintana commented Nov 8, 2021•
edited
Loading

mnquintana commented Jan 12, 2022•
edited
Loading