Skip to content
This repository has been 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

Open
ca-scribner opened this issue Nov 18, 2021 · 2 comments

Comments

@ca-scribner
Copy link
Contributor

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

@jnsgruk
Copy link
Member

jnsgruk commented Nov 19, 2021

Yeh, I'm not hard over on having a name for every step, especially where it's super obvious. Happy to accept PRs ;-)

@ca-scribner
Copy link
Contributor Author

👍

Putting this on my todo list unless someone eager beats me to it

@ca-scribner ca-scribner reopened this Nov 30, 2021
ca-scribner pushed a commit to ca-scribner/operator-template-1 that referenced this issue May 19, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants