Skip to content

Clarify concurrency cancel-in-progress behaviour #30647

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

Merged
merged 5 commits into from
Feb 27, 2024

Conversation

rvesse
Copy link
Contributor

@rvesse rvesse commented Dec 13, 2023

Why:

The section on GitHub Actions concurrency did not cover whether cancel-in-progress could use an expression and several open discussions exists expressing confusion around this e.g.

Closes: #30645

What's being changed (if available, include any code snippets, screenshots, or gifs):

This commit aims to clarify this part of the documentation and include an explicit example of using an expression for cancel-in-progress

It also adds clarifying language so that it is clear that even when cancel-in-progress is, or an expression that evaluates to, false, that there can still only be at most 1 running and 1 pending job in any given concurrency group.

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.
  • For content changes, I have completed the self-review checklist.

Copy link

welcome bot commented Dec 13, 2023

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 13, 2023
@rvesse rvesse force-pushed the concurrency-cancellation-clarifications branch from 9b41d40 to ab0beb4 Compare December 13, 2023 10:42
@nguyenalex836
Copy link
Contributor

@rvesse Thanks so much for opening a PR and linking to your issue! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Dec 13, 2023
@rvesse rvesse force-pushed the concurrency-cancellation-clarifications branch 2 times, most recently from 05b6eb4 to 581b320 Compare December 14, 2023 09:13
@CASABECI

This comment was marked as spam.

CASABECI

This comment was marked as spam.

The section on GitHub Actions concurrency did not cover whether
cancel-in-progress could use an expression and several discussions
exists expressing confusion around this.  This commit aims to clarify
this part of the documentation and include an explicit example of using
an expression for cancel-in-progress.

It also adds clarifying language so that it is clear that even when
cancel-in-progress is, or evaluates to, false, that there can still only
be at most 1 running and 1 pending job in any given concurrency group.
@rvesse rvesse force-pushed the concurrency-cancellation-clarifications branch from 581b320 to f6bd7d6 Compare December 15, 2023 09:12
SiaraMist
SiaraMist previously approved these changes Feb 27, 2024
Copy link
Contributor

@SiaraMist SiaraMist left a comment

Choose a reason for hiding this comment

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

Thank you for adding this content to our docs, @rvesse! I made a couple of style edits to match our content models and style guide. I will just apply those directly to your PR and get this merged! Thanks again for a great contribution. 💛

@SiaraMist SiaraMist added this pull request to the merge queue Feb 27, 2024
Merged via the queue into github:main with commit 1894c03 Feb 27, 2024
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve GitHub Actions concurrency documentations
4 participants