Skip to content
This repository was archived by the owner on Dec 12, 2022. It is now read-only.
This repository was archived by the owner on Dec 12, 2022. It is now read-only.

Should we use name properties for one-liner commands in github workflows? #3

@ca-scribner

Description

@ca-scribner

If we have something like:

jobs:
  lint:
    name: Lint
    runs-on: ubuntu-latest
    steps:
    - name: Do linting
      run: tox -vve lint

do we want to prefer to include the name, or should we prefer omitting the name and leaving the command to self-document? My preference is that our default be:

  • omitting the name for one-liners unless they're very complex (eg: something like date | cut -d" " -f5 should have name: Display current time)
  • requiring a name for multi-liners unless they're really simple

Whatever we do, we should add some comments in the example .github/workflow as a hint

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions