ci: create update-readme workflow
#14
Open
+22
−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
nzakas
reviewed
Oct 22, 2025
| @@ -0,0 +1,2 @@ | |||
| # Automatically generated files by GitHub Actions workflow | |||
| tools/update-readme.js | |||
There was a problem hiding this comment.
The location of this script seems error-prone to me. Can we update the shared workflow to have it download this file to a unique location, like .shared-workflows/tools instead? That way we can add .shared-workflows to every gitignore and not worry about individual files?
There was a problem hiding this comment.
I like your suggestion, but would it be okay to circle back to all repositories to update this accordingly?
Already 13 repositories (per the tracker at eslint/workflows#4) have adopted the ignore location as tools/update-readme.js, so this would require some follow-up.
If that's okay, I can proceed with the changes.
References:
- https://github.com/eslint/workflows/blob/main/.github/workflows/update-readme.yml#L31
- https://github.com/eslint/code-explorer/blob/main/.gitignore#L28-L29
- https://github.com/eslint/eslint-github-bot/blob/main/.gitignore#L24-L25
- https://github.com/eslint/eslint-release/blob/main/.gitignore#L17-L18
- https://github.com/eslint/json/blob/main/.gitignore#L70-L71
- and more...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
In this PR, I've created the
update-readmeworkflow as part of our effort from eslint/workflows#4.The full workflow is available at https://github.com/eslint/workflows/blob/main/.github/workflows/update-readme.yml.
What changes did you make? (Give an overview)
In this PR, I've created the
update-readmeworkflow as part of our effort from eslint/workflows#4.Related Issues
Ref: eslint/workflows#4
Is there anything you'd like reviewers to focus on?
N/A