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
Concurrency examples are inconsistent with English text around them #31988
Comments
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
@strugee Thanks for opening this issue! I'll get this triaged for review ✨ |
This comment was marked as spam.
This comment was marked as spam.
Thanks for the feedback @strugee. We took a look into the issues you raised. A couple considerations/ideas: Cancel in progress
A paragraph immediately before the examples (under the "
So, in this sense, the Since this concept is covered in the overview paragraphs, maybe it makes most sense to completely delete the "Example: Using concurrency to cancel any in-progress job or run" section. Expression
In the example you highlight, change:
to:
|
Ok, sure, but if you make the suggested change now the problem is that concurrency: foo concurrency:
group: foo
Fair enough, I must've misremembered or something. But I still think the example would be clearer if it wasn't included, because it doesn't have anything to do with "Using concurrency and the default behavior". |
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#concurrency
What part(s) of the article would you like to see updated?
This section is just generally very confusing; see this issue's title. Every example uses
group:
andcancel-in-progress:
. However, the latter isn't even supposed to be introduced - AFAICT - until the section labeled "Example: Using concurrency to cancel any in-progress job or run". It's extremely confusing that the first example uses both of these keys but they haven't been introduced yet. As another example, one of the examples talks about specifyingconcurrency: ci-${{ github.ref }}
, and then the following example does not use this expression - it usesgroup: ci-${{ github.ref }}
.Additional information
No response
The text was updated successfully, but these errors were encountered: