SSWConsulting / SSWConsulting/SSW.Rules

🪥 IMPORTANT Linter - Create a GitHub action for SSW Rules and SSW People

Open
#514 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

cc: @pierssinclairssw @adamcogan @wicksipedia
To Myself,

Priority: After Netlify

As per my conversation with Adam and Piers, edit the exisiting GitHub action for GIF/SVG images and add checks for:

  1. A rule URI is the same as the folder name
    e.g. uri: Employee-YOLO-Day
  2. There is no space above or below the YAML frontmatter in a category because this breaks our builds
    https://github.com/SSWConsulting/SSW.Rules/issues/500
    https://github.com/SSWConsulting/SSW.Rules.Content/pull/905
  3. If a library exisits that can check for a valid URI and use it to check rules. If there isn't one, use regex
    e.g. bad - uri: Employee YOLO Day
    good - uri: Employee-YOLO-Day
  4. If a rule URI is invalid or if the rule URI has recently changed and is now a redirected URI
  5. If the type, title, guid, uri or created fields in the frontmatter are empty
  6. There are no spaces in image names
    e.g. bad - my image.png
    good - my-image.png
  7. Check that each rule is in at least one category
  8. If we can't find a way to make links clickable in captions (see #490) find all links inside captions.
  9. Good and Bad example blocks are in the correct syntax e.g.
  10. If there is at least 1 author
  11. If there is at least 2 lines around greyboxes containing bolded text #829
  12. If there is no extra spaces in a blank/new line after tags #829
  13. Images referenced in the markdown exist

bad:

![](Bad One.jpg) ::: bad Figure: Bad Example - using the Website tab :::

good:

::: good
![Figure: Bad Example - using the Website tab](Bad One.jpg)
:::

Thanks,

-Brady

AB#61439

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by inspecting the existing GitHub Action for GIF/SVG checks and the rule/category Markdown and YAML frontmatter it processes. Review issues #500, #490, and #829 plus the linked pull request/work item to resolve expected syntax; done means the action validates the listed URI, frontmatter, image, link, example, author, category, and spacing conditions.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, markdown, typescript, yaml
Domain
ci-cd, documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.