Skip to content

repo sync#12083

Merged
Octomerger merged 5 commits intomainfrom
repo-sync
Nov 17, 2021
Merged

repo sync#12083
Octomerger merged 5 commits intomainfrom
repo-sync

Conversation

@Octomerger
Copy link
Copy Markdown
Contributor

This is an automated pull request to sync changes between the public and private repos.

🤖 This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!

guntrip and others added 4 commits November 17, 2021 15:30
* Use in_progress workflow_job example, not queued

### tl;dr

This changes the example `workflow_job` payload to be an `in_progress` event instead of `queued` event.

### why

In #22174, I added some keys to the example workflow_job json. This was correct, but by adding non-null _values_, **I introduced a subtle bug**.

It's a bug because a `queued` workflow is—by definition—_not_ yet assigned to a runner. So all the `runner_*` attributes will be `null` in the real world. 

After the workflow becomes `in_progress`, all the values are guaranteed to exist. So let's change the example to be an `in_progress` event, since it's a better example for documentation.

* Explain more about the runner_* attributes in "workflow_job_properties.md"

* Consistentize naming

Co-authored-by: Martin Lopes <martin389@github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
@Octomerger Octomerger added automated-reposync-pr Auto label for repo sync autoupdate labels Nov 17, 2021
@github-actions github-actions Bot locked as spam and limited conversation to collaborators Nov 17, 2021
@Octomerger Octomerger enabled auto-merge November 17, 2021 15:57
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Nov 17, 2021
@Octomerger Octomerger merged commit b35bb2b into main Nov 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

automated-reposync-pr Auto label for repo sync triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants