jelhan / create-github-actions-setup-for-ember-addon

Setup GitHub Actions for an Ember Addon
MIT License
19 stars 2 forks source link

Improve readability of created workflow #15

Closed jelhan closed 3 years ago

jelhan commented 3 years ago

@ijlee2 proposed to add empty lines between each step and after each job to improve readability:

It may also help to add 1 empty line after each step and 2 empty lines after each job. I find that this helps me read a workflow more easily.

See https://github.com/jelhan/ember-style-modifier/pull/32#issuecomment-735256781 for more context.

ijlee2 commented 3 years ago

I think I can help out with this issue. I'm guessing that I'd need to update the following files:

?

jelhan commented 3 years ago

That would be awesome.

I'm guessing that I'd need to update the following files:

* https://github.com/jelhan/create-github-actions-setup-for-ember-addon/blob/master/templates/.github/workflows/ci.yml

* Test snapshots

Exactly. But no need to update the snapshots manually. To update them run yarn test with -u flag.

Normally I'm following this flow for such issues:

  1. Change the template in templates/.github/workflows/ci.yml.
  2. Run yarn test -u.
  3. Verify that snapshots only contain expected changes.
  4. Commit and open merge request.