[PR #1851] [CLOSED] auto awesome-lint any list added to the readme in a PR #1898

New Issue

2025-11-06T16:02:48-06:00

GiteaMirror commented

2025-11-06 16:02:48 -06:00

📋 Pull Request Information

Original PR: https://github.com/sindresorhus/awesome/pull/1851
Author: @RayBB
Created: 8/17/2020
Status: ❌ Closed

Base: main ← Head: ci-cd

📝 Commits (10+)

632fe1a add ci cd
4b2f559 all beta
bb9f28d export
3ed673a status
e988445 depth 0
beee3d9 fetch-depth: 0
2014b39 fetch
52acd89 main
f73eccc diff
4d38db8 diff 2

📊 Changes

1 file changed (+43 additions, -0 deletions)

View changed files

➕ .github/workflows/main.yml (+43 -0)

📄 Description

I really appreciate this project and wanted to try to give back so it's a little easier for everyone involved.
To that end, I created this PR to automatically lint new lists when someone opens a PR to add them.

Benefits

It will save time of maintainers by allowing them to look at the error message first
It will provide immediate feedback to people who make a PR
It helps people having trouble installing awesome-lint
It is free

Risks

As far as I know, there is no risk to users or maintainers unless.

What it does

PR will lint NEW lists that are requesting to be added.
PR will NOT lint this repo itself. If that functionality is desired it can happen in a separate PR (see https://github.com/sindresorhus/awesome/pull/1794).
PR will NOT lint the current lists in the readme.

How it does it

This PR creates a GitHub action that will do the following every time a new commit is pushed to an open PR:

Find the URL that is being added using git diff
Clone that repo
Run awesome-linton that repo.

The above 3 steps will ONLY run if readme.md is changed.
If readme is changed and no new URL is detected in the readme it will fail with a helpful error message.
Error can be ignored if it is a cosmetic PR

Here are examples of failing commits.

Final notes

"Squash and Merge" this PR or let me know and I will squash it manually.

Feel free to edit this any way you see fit or ask me to make the edits. 👍
If there are any questions on how this works drop them here and I'll try my best to answer.

Again, thanks so much for all the hard work the maintainers put into this repo! 👏

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/sindresorhus/awesome/pull/1851 **Author:** [@RayBB](https://github.com/RayBB) **Created:** 8/17/2020 **Status:** ❌ Closed **Base:** `main` ← **Head:** `ci-cd` --- ### 📝 Commits (10+) - [`632fe1a`](https://github.com/sindresorhus/awesome/commit/632fe1a5015436857610b0e9c446d1d15712dd39) add ci cd - [`4b2f559`](https://github.com/sindresorhus/awesome/commit/4b2f559a33d5bff6841a1fc75af6cfcb05d1abbd) all beta - [`bb9f28d`](https://github.com/sindresorhus/awesome/commit/bb9f28d34d614d21fa83e863d02e734664d26e3f) export - [`3ed673a`](https://github.com/sindresorhus/awesome/commit/3ed673a1a1658397f10068d4f64cdb3d7416098f) status - [`e988445`](https://github.com/sindresorhus/awesome/commit/e9884453560ab9572d7dc23e6f9b4a6dbf7f0ef3) depth 0 - [`beee3d9`](https://github.com/sindresorhus/awesome/commit/beee3d9ab2023f543979d5caa53d4884d62baaac) fetch-depth: 0 - [`2014b39`](https://github.com/sindresorhus/awesome/commit/2014b397a9237be1ca0242a9812470af673e5948) fetch - [`52acd89`](https://github.com/sindresorhus/awesome/commit/52acd89ee6726cc394c858cfd3e57bb2a29dfa7e) main - [`f73eccc`](https://github.com/sindresorhus/awesome/commit/f73ecccf66f74d922dee680d14fad071645c9c7e) diff - [`4d38db8`](https://github.com/sindresorhus/awesome/commit/4d38db8a3e268381144d9ecfcf2f7ee695bb6d95) diff 2 ### 📊 Changes **1 file changed** (+43 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/main.yml` (+43 -0) </details> ### 📄 Description I really appreciate this project and wanted to try to give back so it's a little easier for everyone involved. To that end, I created this PR to **automatically lint new lists** when someone opens a PR to add them. ## Benefits - It will save time of maintainers by allowing them to look at the error message first - It will provide immediate feedback to people who make a PR - It helps people having trouble installing `awesome-lint` - It is free ## Risks - As far as I know, there is no risk to users or maintainers unless. ## What it does - PR will lint **NEW** lists that are requesting to be added. - PR will **NOT** lint [this](https://github.com/sindresorhus/awesome/) repo itself. If that functionality is desired it can happen in a separate PR (see https://github.com/sindresorhus/awesome/pull/1794). - PR will **NOT** lint the current lists in the readme. ## How it does it This PR creates a GitHub action that will do the following every time a new commit is pushed to an open PR: 1. Find the URL that is being added using `git diff` 2. Clone that repo 3. Run `awesome-lint`on that repo. The above 3 steps will **ONLY** run if `readme.md` is changed. If readme is changed and no new URL is detected in the readme it will fail with a helpful error message. Error can be ignored if it is a cosmetic PR [Here](https://github.com/RayBB/awesome/pull/1) are examples of failing commits. ## Final notes "Squash and Merge" this PR or let me know and I will squash it manually. Feel free to edit this any way you see fit or ask me to make the edits. 👍 If there are any questions on how this works drop them here and I'll try my best to answer. Again, thanks so much for all the hard work the maintainers put into this repo! 👏 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2025-11-06 16:02:48 -06:00

GiteaMirror closed this issue