docs icon indicating copy to clipboard operation
docs copied to clipboard

actions(concurrency): fix typo

Open amithm7 opened this issue 3 years ago • 2 comments

Why:

To cancel workflows in same concurrency group, cancel-in-progress: true option is needed.

Currently docs state, "will be cancelled" which implies it as default behavior, although it is not.

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

"will be cancelled" -> "can be cancelled"

Check off the following:

  • [x] I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • [x] For content changes, I have completed the self-review checklist.

amithm7 avatar Jan 02 '23 06:01 amithm7

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.

welcome[bot] avatar Jan 02 '23 06:01 welcome[bot]

@amithm7 Thanks so much for opening a PR! I'll get this triaged for review :zap:

cmwilson21 avatar Jan 03 '23 15:01 cmwilson21

Thanks for opening this issue! You are correct that you must specify cancel-in-progress: true in order to cancel any job/workflow that is currently running. However, any pending jobs/workflows should be canceled by default. With that distinction in mind, I'm going to close this PR, but I hope to see more contributions from you in the future! If you feel that I am mistaken or misunderstood you, feel free to open an issue and we can discuss more.

skedwards88 avatar Feb 02 '23 19:02 skedwards88