monthly-check: improve username validation workflow #19151

waldyrious · 2025-10-31T19:28:52Z

Refactor the monthly username validation workflow for improved clarity and maintainability.

Also update lychee.md to the link to the CLI documentation page in the docs site.

waldyrious · 2025-10-31T19:33:40Z

.github/workflows/monthly-check.yml

-    - name: Restore lychee cache
-      id: restore-cache
-      uses: actions/cache/restore@v4
-      with:
-        path: .lycheecache
-        key: cache-lychee-${{ github.sha }}
-        restore-keys: cache-lychee-


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.

.github/workflows/monthly-check.yml

waldyrious · 2025-10-31T19:53:33Z

.github/workflows/monthly-check.yml

+      id: last-issue # Step ID to reference later
      with:
-        state: open
+        state: all


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.

waldyrious · 2025-10-31T19:55:02Z

.github/workflows/monthly-check.yml

+          --no-progress
          --max-concurrency 25
-          usernames.txt
+          --output lychee_report.txt


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.

waldyrious · 2025-10-31T20:14:47Z

.github/workflows/monthly-check.yml

-    - 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'


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).

Refactor the monthly username validation workflow for improved clarity and maintainability. Also update lychee.md to the link to the CLI documentation page in the docs site.

waldyrious · 2025-10-31T20:21:45Z

(I wanted to also rename the file from monthly-check.yml to monthly-username-check.yml, but then git/github stopped being able to recognize that it was the same file, and showed the diff as a deleted file and an added one. I might do that change in a separate PR.)

waldyrious · 2025-10-31T20:37:49Z

Btw, the current workflow doesn't seem to be working correctly: the last run did fail to load some of the userpages (though for reasons other than them actually being invalid), but skipped the issue update steps, for reasons that are not clear to me.

Screenshot of the job log/output for future reference, since they will eventually be deleted:

sbrl

Looks cool, and definitely improves maintainability here! Just thought I'd drop some comments while I'm thinking about it haha

sbrl · 2025-11-01T01:47:35Z

.github/workflows/monthly-check.yml

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


Offsetting this to a random value would be better practice, as if everyone does the same thing GitHub servers would be overwhelmed at the same time every month.

Hence perhaps do e.g. 1:24am or smth?

I don't have a strong opinion either way. I'll wait for others to chime in.

Looking at the last runs, it seems it is some kind of "random" already: https://github.com/tldr-pages/tldr/actions/workflows/monthly-check.yml?query=event%3Aschedule

mmmm true

it's just the sysadmin in me speaking haha

either way this is just a minor thing really

.github/workflows/monthly-check.yml

sebastiaanspeck · 2025-11-01T07:11:59Z

Btw, the current workflow doesn't seem to be working correctly: the last run did fail to load some of the userpages (though for reasons other than them actually being invalid), but skipped the issue update steps, for reasons that are not clear to me.

Screenshot of the job log/output for future reference, since they will eventually be deleted:

Could you test if this PR fixed the issue?

sebastiaanspeck · 2025-11-01T07:15:27Z

.github/workflows/monthly-check.yml

+    - name: Extract GitHub usernames for validation
+      run: |
+        {
+          grep -oP         '@[\w-]+' .github/CODEOWNERS


Suggested change

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

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

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?

.github/workflows/monthly-check.yml

waldyrious · 2025-11-01T10:45:57Z

Could you test if this PR fixed the issue?

Sure. How can I do that test? Maybe temporarily changing the triggering conditions of the workflow so it executes in this PR?

sebastiaanspeck · 2025-11-01T22:21:18Z

Could you test if this PR fixed the issue?

Sure. How can I do that test? Maybe temporarily changing the triggering conditions of the workflow so it executes in this PR?

We do have workflow_dispatch already, so you can trigger it manually on this branch.

waldyrious · 2025-11-01T22:51:31Z

Thanks! That seems to have done the trick: https://github.com/tldr-pages/tldr/actions/runs/19003751429/job/54274077842

I think I might change the action to add a comment to the issue instead of modifying the existing opening comment, to make the historical progression easier to follow.

sbrl

Cool!

(take my time suggestion or leave it, it's p minor)

sebastiaanspeck · 2025-11-04T06:01:23Z

Thanks! That seems to have done the trick: https://github.com/tldr-pages/tldr/actions/runs/19003751429/job/54274077842

I think I might change the action to add a comment to the issue instead of modifying the existing opening comment, to make the historical progression easier to follow.

I see we still have the issue about running into a 403 for 10 valid users. Are you able to fix that as well?

waldyrious requested review from kbdharun, sbrl and sebastiaanspeck as code owners October 31, 2025 19:28

github-actions bot added page edit Changes to an existing page(s). tooling Helper tools, scripts and automated processes. labels Oct 31, 2025

waldyrious marked this pull request as draft October 31, 2025 19:30

waldyrious commented Oct 31, 2025

View reviewed changes

waldyrious force-pushed the username-check-improvements branch from c17ad30 to 9f056fc Compare October 31, 2025 19:48

waldyrious commented Oct 31, 2025

View reviewed changes

.github/workflows/monthly-check.yml Show resolved Hide resolved

waldyrious commented Oct 31, 2025

View reviewed changes

monthly-check: Improve username validation workflow

330d7c2

Refactor the monthly username validation workflow for improved clarity and maintainability. Also update lychee.md to the link to the CLI documentation page in the docs site.

waldyrious force-pushed the username-check-improvements branch from 9f056fc to 330d7c2 Compare October 31, 2025 20:16

waldyrious marked this pull request as ready for review October 31, 2025 20:28

kbdharun added the hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. label Nov 1, 2025

sbrl reviewed Nov 1, 2025

View reviewed changes

sebastiaanspeck reviewed Nov 1, 2025

View reviewed changes

Set output in action configuration instead of args

63d0563

sbrl approved these changes Nov 3, 2025

View reviewed changes

kbdharun changed the title ~~monthly-check: Improve username validation workflow~~ monthly-check: improve username validation workflow Nov 4, 2025

kbdharun approved these changes Nov 4, 2025

View reviewed changes

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

Uh oh!

monthly-check: improve username validation workflow #19151

Are you sure you want to change the base?

monthly-check: improve username validation workflow #19151

Conversation

waldyrious commented Oct 31, 2025

Uh oh!

waldyrious Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

waldyrious Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

waldyrious Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

waldyrious Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

waldyrious commented Oct 31, 2025

Uh oh!

waldyrious commented Oct 31, 2025

Uh oh!

sbrl left a comment

Choose a reason for hiding this comment

Uh oh!

sbrl Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

waldyrious Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

sebastiaanspeck Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

sbrl Nov 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sebastiaanspeck commented Nov 1, 2025

Uh oh!

sebastiaanspeck Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

waldyrious Nov 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

waldyrious commented Nov 1, 2025

Uh oh!

sebastiaanspeck commented Nov 1, 2025

Uh oh!

waldyrious commented Nov 1, 2025

Uh oh!

sbrl left a comment

Choose a reason for hiding this comment

Uh oh!

sebastiaanspeck commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

waldyrious Oct 31, 2025 •

edited

Loading

waldyrious Oct 31, 2025 •

edited

Loading

waldyrious Oct 31, 2025 •

edited

Loading