1
0
mirror of synced 2025-12-26 05:02:55 -05:00
Files
docs/data
Patrick Ellis 4b5e01365c Use in_progress workflow_job example, not queued (#22880)
* 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>
2021-11-17 15:48:31 +00:00
..
2021-07-14 13:49:18 -07:00
2021-11-10 11:11:28 -08:00

Data

This directory contains data files that are parsed and made available to pages in the site.data object.

All YML and Markdown files in this directory are configured to be translated on Crowdin by default.

Glossaries

Glossary files are used by our Crowdin integration. See glossaries/README.md.

GraphQL

GraphQL schema files are kept in sync with github/github via scheduled workflows. See graphql/README.md.

Reusables

Reusables are long strings of reusable text. See reusables/README.md.

Variables

Variables are short strings of reusable text. See variables/README.md.

Webhooks

Webhook payload JSON files are used in the webhook events docs.

ui.yml

ui.yml contains localized strings used in layouts.

Learning Tracks

Learning tracks are a collection of articles that help you master a particular subject. See learning-tracks/README.md.