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