Conversation
…ate gitignore path
…flect automated index management
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
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.
Description
This PR introduces a fully automated GitHub Actions workflow to manage the root category JSON files (
brands.json,regular.json), removing the need for manual updates from contributors. It also significantly improves the repository's documentation and issue management structure.Key Changes:
update-category.yml) that triggers on PRs, pushes tomain/master, and release tags. It automatically scans thebrands/andregular/directories and compiles the root index JSON files.update-category.ts) with strict typing, bundled efficiently viatsup. To keep the root clean, all script configuration (package.json,tsconfig.json) was moved into the.github/scripts/directory.CONTRIBUTING.mdandREADME.mdto instruct users to just drop their.jsonfiles into the category folders, removing outdated manual SVG and index instructions..github/PULL_REQUEST_TEMPLATE.mdto enforce the new workflow rules via a checklist. Additionally, created GitHub Issue templates for Icon Requests, Bug Reports, and Feature Requests to better organize community feedback.Checklist
Please make sure your Pull Request follows these guidelines:
.jsonicon file in the correct category directory (brands/orregular/).my-brand.json).brands.jsonorregular.jsonfiles (our GitHub Actions workflow will handle this automatically!).Additional Notes
Tested locally by running the build script in
.github/scriptsand everything successfully updatesbrands.jsonandregular.json.