-
-
Notifications
You must be signed in to change notification settings - Fork 2
feat: create update-readme.yml
#12
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.
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
Open
lumirlumir
wants to merge
12
commits into
main
Choose a base branch
from
lumirlumir-patch-2
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+100
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lumirlumir
commented
Sep 1, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If it's okay, could this PR include only a ## Sponsors
heading for now, so we can verify the update-readme
workflow is working correctly in the workflows
repository?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request?
Overview
In this PR, I created the
update-readme.yml
workflow.I inlined and consolidated the logic that was originally in
tools/commit-readme.sh
,tools/update-readme.js
, and.github/workflows/update-readme.yml
in each repository.The original implementation used the
got
package to fetch data, but the workflow now runs on Node.js LTS and the nativefetch
API is available, so thegot
package is no longer needed.Support both multirepo and monorepo setups
This workflow works well for both multirepo and monorepo setups.
According to #4, 7 repositories use the
update-readme
script.There are two types of the
update-readme
script: one updates only the root-levelREADME.md
(multirepo), and the other updates allREADME.md
files under thepackages
directory as well as the root-levelREADME.md
(monorepo).I've taken these two types of
update-readme
script into account.Multirepo
Monorepo
Exception
eslint/eslint
repository is an exception, as it uses a slightly different form of theupdate-readme
script.How did you test this change?
I've tested the workflow in my personal repository ( https://github.com/lumirlumir/test-update-readme ) with my Personal Access Token and confirmed it works correctly for both multirepo and monorepo setups.
Multirepo test example
lumirlumir/test-update-readme@c066348
https://github.com/lumirlumir/test-update-readme/actions/runs/17358680977/job/49275514381
Monorepo test example
lumirlumir/test-update-readme@c14102e
https://github.com/lumirlumir/test-update-readme/actions/runs/17380613326/job/49337017695
What changes did you make? (Give an overview)
In this PR, I created the
update-readme.yml
workflow.Related Issues
Ref: #4
Is there anything you'd like reviewers to focus on?
There is a prerequisite for this workflow to function as expected:
WORKFLOW_PUSH_BOT_TOKEN
secret set at the organization level?