`jobs.<job_id>.steps.args` incorrectly documented

The documentation section in question: https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepsargs

The actual path it documents is jobs.\<job_id\>.steps.with.args

4 Likes

Or perhaps if it is documented correctly. If it is then I’m getting errors like:

Your workflow file was invalid: .github/workflows/release.yml (Line: 20, Col: 7): Unexpected value 'args'
2 Likes

Thank you for this! Confirming that adding with works for me.

1 Like

It looks like a number of the fields documented below this one are also affected.

I too can confirm this.

This, contra the current docs, does not work:

name: Document Conversion

on: push

jobs:
  convert_via_pandoc:
    name: Convert via Pandoc
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v1
      - uses: maxheld83/pandoc@master
        args: "--standalone --output=index.html README.md"

This does work, though that’s not how it’s documented:

name: Document Conversion

on: push

jobs:
  convert_via_pandoc:
    name: Convert via Pandoc
    runs-on: ubuntu-18.04
    steps:
      - uses: actions/checkout@v1
      - uses: maxheld83/pandoc@master
        with:
          args: "--standalone --output=index.html README.md"

Writing to support to get their attention.

2 Likes

the docs now appear to be fixed: https://help.github.com/en/articles/workflow-syntax-for-github-actions#jobsjob_idstepswithargs

1 Like