Skip to content

Conversation

lumirlumir
Copy link
Member

@lumirlumir lumirlumir commented Aug 12, 2025

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 native fetch API is available, so the got 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.

image

There are two types of the update-readme script: one updates only the root-level README.md (multirepo), and the other updates all README.md files under the packages directory as well as the root-level README.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 the update-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

image

Monorepo test example

lumirlumir/test-update-readme@c14102e

https://github.com/lumirlumir/test-update-readme/actions/runs/17380613326/job/49337017695

image

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:

  • Is WORKFLOW_PUSH_BOT_TOKEN secret set at the organization level?

@eslintbot eslintbot added this to Triage Aug 12, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Aug 12, 2025
@lumirlumir lumirlumir added the accepted There is consensus among the team that this change meets the criteria for inclusion label Aug 12, 2025
@nzakas nzakas moved this from Needs Triage to Implementing in Triage Aug 19, 2025
Copy link
Member Author

@lumirlumir lumirlumir Sep 1, 2025

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?

@lumirlumir lumirlumir marked this pull request as ready for review September 1, 2025 14:44
@lumirlumir lumirlumir requested a review from a team September 1, 2025 14:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion feature
Projects
Status: Implementing
Development

Successfully merging this pull request may close these issues.

1 participant