ci: check `metadata.toml` files

Open
#2,061 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions
Domain
ci-cd

Research direction

Start with the ci.yml workflow and trace how its existing Markdown and JSON checks are implemented. Add coverage for metadata.toml according to the listed presence, key, value, and unknown-key rules, then verify that configlet sync no longer encounters invalid metadata when syncing includes it.

Written by the indexing model from the issue text.

Description

The prob-specs ci.yml workflow checks Markdown and JSON files, but not the metadata.toml files.

In the hopefully-unlikely event that a strictly invalid metadata.toml file reaches main, configlet sync would produce an error to complain about the invalid TOML when the syncing scope includes metadata.

We could check that:

  • every exercise has a metadata.toml file
  • with a valid title key/value pair
  • with a valid blurb key/value pair
  • if the source key is present, the value is valid
  • if the source_url key is present, the value is valid
  • there is no other key/value pair (it may be a typo of source or source_url, like source-url)
Dominant language
Ruby
Stars
362
Forks
566
Avg merge
15h 13m
Merged PRs (30d)
8

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from exercism/problem-specifications

All issues in exercism/problem-specifications

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.