NVIDIA-Merlin / NVIDIA-Merlin/Merlin

[Task] Add YAML Formatter to ensure GitHub Actions configuration can be loaded

Open
#764 0 comments 0 reactions 2 assignees View on GitHub

@karlhigley is already working on this.

Since Jan 17, 2023.

ci
Dominant language
Python
Stars
907
Forks
129
PR merge metrics
No merged PRs in 30d

Description

Description

When making changes or adding new GitHub Actions Workflows to our projects. Without a check for valid YAML files, we can end up in situations where we're puzzled about why a workflow doesn't show up as a job in a Pull Request list of Actions.

Adding a YAML formatter, reduces this risk and saves time by preventing formatting errors from showing up in our configuration.

Proposed YAML formatter: Prettier. This one of the most widely used YAML formatters and adopted by tools like the YAML vs Code Extension

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.