Skip to content

Fix miscellaneous errors in GitHub Actions / Reference / Workflow syntax #825

@gsrohde

Description

@gsrohde

What article on docs.github.com is affected?

https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-syntax-for-github-actions

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

  1. Under the section jobs.<job_id>.steps.run in the subsection Exit codes and error action preference: Under the bullet point for cmd, the second item starts out "cmd.exe will exit with the error level of the last program it executed, and it will and return the error code to the runner." The second "and" is extraneous and should be deleted.

  2. The last sentence in the section jobs.<job_id>.steps.with.entrypoint reads "The entrypoint keyword is meant to use with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs." "to use" should be changed to "to be used".

  3. This is a general comment about the syntax of the syntax article: Since, for the most part, the YAML used in workflow files can be considered a form of JSON, it indeed makes some sense to use JavaScript-like syntax to refer to the parts of the YAML file. For example, jobs.<job_id>.timeout-minutes clearly refers to the value corresponding to the timeout-minutes key in the hash value corresponding to the <job_id> key in the hash value corresponding to the jobs key, and this is precisely how you would refer to it in JavaScript. Where it gets confusing is in notations such as jobs.<job_id>.steps.timeout-minutes. This is because the value corresponding to the steps key is not another hash but rather an array (of steps). Using the dot notation obscures the fact that in this case, timeout-minutes applies to a particular step and doesn't apply to the set of steps as a whole. It would be clearer to write something like jobs.<job_id>.steps[n].timeout-minutes to make clear that timeout-minutes applies only to some particular step n and not to all steps. The [n] here stands in for any step in the sequence analogously to the way <job_id> stands in for some particular key in the jobs hash.

Metadata

Metadata

Assignees

No one assigned

    Labels

    actionsThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamecosystemThis issue or pull request should be reviewed by the Docs Ecosystem teamgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions