docs icon indicating copy to clipboard operation
docs copied to clipboard

Update confusing wording on using self-hosted runners in a workflow

Open Lehcar opened this issue 3 years ago • 2 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow#using-custom-labels-to-route-jobs

What part(s) of the article would you like to see updated?

This line: "These labels operate cumulatively, so a self-hosted runner’s labels must match all four to be eligible to process the job." is confusing because a job will run as long as a job's label is a subset of the labels on the self-hosted runner. But I was interpreting the sentence above to mean that the labels need to exactly match on both the job and on the runner.

I think changing the wording to: "These labels operate cumulatively, so a self-hosted runner must have all four labels to be eligible to process the job." might make this a bit more clear.

Additional information

No response

Lehcar avatar Aug 09 '22 19:08 Lehcar

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.

welcome[bot] avatar Aug 09 '22 19:08 welcome[bot]

@Lehcar Thanks for opening an issue and linking it to your PR! 💖

cmwilson21 avatar Aug 10 '22 16:08 cmwilson21