Skip to content

monthly-check: improve username validation workflow #19151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
+37 −39
Draft

monthly-check: improve username validation workflow #19151

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
330d7c2
monthly-check: Improve username validation workflow
waldyrious Oct 31, 2025
63d0563
Set output in action configuration instead of args
waldyrious Nov 1, 2025
cb1b8d4
Merge branch 'main' into username-check-improvements
sebastiaanspeck Nov 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 35 additions & 37 deletions .github/workflows/monthly-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Monthly check GitHub usernames
name: Monthly check GitHub usernames in CODEOWNERS and MAINTAINERS.md

on:
workflow_dispatch:
schedule:
- cron: "0 0 1 * *"
- cron: "0 0 1 * *" # Run on the 1st of every month at midnight UTC

permissions:
contents: read
Expand All @@ -13,62 +13,60 @@ jobs:
check-usernames:
runs-on: ubuntu-latest
steps:
- name: Restore lychee cache
id: restore-cache
uses: actions/cache/restore@v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
Comment on lines -16 to -22
Copy link
Member Author

@waldyrious waldyrious Oct 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed cache read/write steps because the default cache duration is 1 day while we're running this only once a month, so the cace would be expired anyway. Besides, we don't want to cache results, since indeed they may change between runs.


- uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
- name: Checkout repository
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
with:
fetch-depth: 0

- run: |
cat .github/CODEOWNERS | grep -o "@[a-zA-Z0-9_-]\+" | sort -u | sed 's/@/https:\/\/api.github.com\/users\//' > usernames.txt
cat MAINTAINERS.md | grep -o "\*\*.*@[a-zA-Z0-9_-]\+.*\*\*" | grep -o "@[a-zA-Z0-9_-]\+" | sort -u | sed 's/@/https:\/\/api.github.com\/users\//' >> usernames.txt
sort -u usernames.txt -o usernames.txt
# Extract GitHub @usernames from the CODEOWNERS and MAINTAINERS.md files
# and convert them to GitHub API URLs for validation
- name: Extract GitHub usernames for validation
run: |
{
grep -oP '@[\w-]+' .github/CODEOWNERS
Copy link
Member

@sebastiaanspeck sebastiaanspeck Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
grep -oP '@[\w-]+' .github/CODEOWNERS
grep -oP '@[\w-]+' .github/CODEOWNERS

Copy link
Member Author

@waldyrious waldyrious Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did it that way to make it more obvious that both patterns are looking for the same thing, with the only difference being the ** prefix in the second one. Do you think it makes it more confusing than helpful?

grep -oP '\*\*.+\K@[\w-]+' MAINTAINERS.md # Only get current maintainers (marked up in **bold**)
} | sort -u | sed 's#@#https://api.github.com/users/#' > username_urls.txt
- name: Lychee URL checker
- name: Validate GitHub usernames with the Lychee URL checker
uses: lycheeverse/lychee-action@885c65f3dc543b57c898c8099f4e08c8afd178a2 # v2.6.1
id: lychee
id: lychee # Step ID to reference later
continue-on-error: true
with:
args: >-
--cache
--verbose
--no-progress
--verbose
--no-progress
--max-concurrency 25
usernames.txt
--output lychee_report.txt
Copy link
Member Author

@waldyrious waldyrious Oct 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I explicitly defined the output filename here, rather than let the action use the default one, since it's referenced further down in the workflow, and this way it is a bit clearer where it comes from.

username_urls.txt
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Find the last report issue open
- name: Find an existing username validation issue
uses: micalevisk/last-issue-action@0d40124cc99ac8601c2516007f0c98ef3d27537b # v2.3.0
id: last-issue
id: last-issue # Step ID to reference later
with:
state: open
state: all
Copy link
Member Author

@waldyrious waldyrious Oct 31, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's no need to only update an existing issue if it is open; so I changed this to search for closed ones too, and modified the last step in the workflow to reopen the closed issue if needed.

labels: check usernames
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Update last report open issue created
if: ${{ env.lychee_exit_code != 0 }}
- name: Create or update username validation issue if there are errors
if: steps.lychee.outcome == 'failure'
Copy link
Member Author

@waldyrious waldyrious Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Used the standard outcome field of GitHub Actions steps rather than relying on an a custom environment variable whose definition is hidden (and which is not even being used by the lychee action anymore).

uses: peter-evans/create-issue-from-file@fca9117c27cdc29c6c4db3b86c48e4115a786710 # v6.0.0
with:
title: GitHub usernames with errors
content-filepath: lychee/out.md
content-filepath: lychee_report.txt
issue-number: ${{ steps.last-issue.outputs.issue-number }}
labels: check usernames

- name: Close last report open issue
if: ${{ env.lychee_exit_code == 0 && steps.last-issue.outputs.has-found == 'true' }}
run: gh issue close ${{ steps.last-issue.outputs.issue-number }}

- name: Save lychee cache
uses: actions/cache/save@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3
if: always()
with:
path: .lycheecache
key: ${{ steps.restore-cache.outputs.cache-primary-key }}
- name: Close or reopen username validation issue as needed
if: steps.last-issue.outputs.has-found == 'true'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
if [[ "${{ steps.lychee.outcome }}" == "success" ]]; then
gh issue close ${{ steps.last-issue.outputs.issue-number }} --comment "All usernames are valid again. Closing this issue."
else
gh issue reopen ${{ steps.last-issue.outputs.issue-number }} --comment "Invalid usernames found. Reopening this issue."
fi
2 changes: 1 addition & 1 deletion pages/common/lychee.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# lychee

> Find broken URLs.
> More information: <https://github.com/lycheeverse/lychee/blob/master/README.md#commandline-usage>.
> More information: <https://lychee.cli.rs/guides/cli/>.

- Scan a website for broken links:

Expand Down
Loading