-
-
Notifications
You must be signed in to change notification settings - Fork 721
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
[Feature]: README.md automation #832
Labels
Comments
Sorry the information in the README file is out of date. I am thinking that it might be a good idea to remove the icon set version information from the README.md. It is currently available on the web page and in |
This was referenced Nov 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe
I've found that the content reflected in the README.md is incorrect or not updated properly when icons are added.
For instance, in the README.md, Grommet-Icons are shown as version 4.9.0, but the actual version in the Grommet-Icons repository is 4.11.0.
Therefore, I want to automate the README.md so that when icons are added, information about the icons is automatically reflected in the README.md.
Solution
I can use GitHub Actions to automate this process.
'packages/react-icons/VERSIONS' file contains information about IconLibrary, License, Version, and Count.
Whenever icon is added, this file must be modified.
Therefore, when the VERSIONS file is modified and pushed, the corresponding information will be automatically reflected in the README.
After creating a .yml file, I plan to write a script for updating the README to be executed in the GitHub Actions workflow.
Minimal sample repository URL
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: