What does jobs.<job_id>.with.<with_id> match?

[rhysd]

Select Topic Area

Question

Body

The 'Context availability' table has jobs.<job_id>.with.<with_id> workflow key. And it is apparently different from jobs.<job_id>.with.

However I couldn't find what jobs.<job_id>.with.<with_id> actually matches. What does it match?

[Kik07L]

The jobs.<job_id>.with.<with_id> syntax you mentioned does not match any standard syntax in GitHub Actions workflows. The correct syntax for specifying inputs to a job or a step within a job is jobs.<job_id>.with.

Job-level inputs: GitHub Actions does not support with at the job level. Inputs are typically specified at the step level within a job.

Step-level inputs: The with keyword is used to pass inputs to an action or a script within a step.

Example of using with at the step level:

name: Example Workflow

on: [push]

jobs:
example-job:
runs-on: ubuntu-latest

steps:
  - name: Checkout repository
    uses: actions/checkout@v2

  - name: Run a script
    run: echo "Hello, world!"

  - name: Example action
    uses: actions/example-action@v1
    with:
      input1: value1
      input2: value2

In this example, the with keyword is used to pass input1 and input2 to actions/example-action@v1.

[rhysd]

Thank you for your answer. So the official document lists a meaningless workflow key, right?

[Kik07L]

the "jobs.<job_id>.with.<with_id>" structure is not standard in GitHub Actions' syntax. The documentation might be incorrectly i dont really know.

[rhysd]

OK, I'll suggest a fix for the document later. Thanks again.