lineageos4microg/docker-lineage-cicd

Automate URL and typo checking when `README.md` is checked in

Open

#500 opened on Oct 30, 2023

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Shell (206 forks)github user discovery
enhancementhelp wanted

Repository metrics

Stars
 (555 stars)
PR merge metrics
 (Avg merge 1d 13h) (6 merged PRs in 30d)

Description

We should implement some tests / checks to be run when README.md is run.

The following comment has details of how to check for incorrect URLs, and for 'space before comma' typos

I have not used the Markdown editor MarkText for this commit (hence #499), but with its spell checker (on Linux Mint in my case) already raises some typos such as:

  • buid
  • intallation
  • knowlegdeable

In addition to find out incorrect commas use:

grep -E " ,|,'" README.md

I just established (hence #499) the following command-line to check URL updates:

grep -Eo "(http|https)://[a-zA-Z0-9./?=_%:-]*" README.md | sort -u | xargs -i sh -c 'curl -s -I "{}" | grep -wq "301" && echo "{}" && curl -s -I "{}" | grep location | cut -d ':' -f2-'> ```


currently outputting:

https://source.android.com/setup/build/building /docs/setup/build/building

The tests should be implemented in a new workflow README-check.yml

Contributor guide

Research direction
Create a new GitHub Actions workflow file '.github/workflows/README check.yml' that runs shell commands to check for broken URLs (using curl) and common typos (using grep). Use the provided command examples from the issue. Test it locally first.
Tech stack
shell
Domain
ci cd
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80