{"id":13538031,"url":"https://github.com/metaory/github-readme-topics-action","last_synced_at":"2025-04-13T13:55:35.596Z","repository":{"id":186183292,"uuid":"674751039","full_name":"metaory/github-readme-topics-action","owner":"metaory","description":":pushpin: GitHub Action to update GitHub profile README.md with categorized repos based on their Topics","archived":false,"fork":false,"pushed_at":"2024-06-27T08:14:38.000Z","size":2038,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-13T13:55:30.126Z","etag":null,"topics":["automation","github-actions","github-readme","github-readme-profile","github-readme-stats","profile","profile-readme","profile-readme-generator"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/github-readme-topics-action","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/metaory.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-04T17:19:05.000Z","updated_at":"2025-01-06T16:36:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"a10ad4a9-dce0-4a97-afbe-904fba545d80","html_url":"https://github.com/metaory/github-readme-topics-action","commit_stats":null,"previous_names":["metaory/github-profile-pinned-action","metaory/github-readme-topics-action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metaory%2Fgithub-readme-topics-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metaory%2Fgithub-readme-topics-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metaory%2Fgithub-readme-topics-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metaory%2Fgithub-readme-topics-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metaory","download_url":"https://codeload.github.com/metaory/github-readme-topics-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248724589,"owners_count":21151559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["automation","github-actions","github-readme","github-readme-profile","github-readme-stats","profile","profile-readme","profile-readme-generator"],"created_at":"2024-08-01T09:01:05.933Z","updated_at":"2025-04-13T13:55:35.575Z","avatar_url":"https://github.com/metaory.png","language":"JavaScript","readme":"# GitHub Profile Readme Topics Action\n\n:pushpin: GitHub Action to update GitHub profile README.md with categorized repos based on their Topics\n\n---\n\n### Inputs\n\n- `TOPICS`: list of topics to categorize repos by\n- `EMAIL`: git user email address\n- `USERNAME`: _OPTIONAL_; git username; defaults to repository owner\n- `REPOSITORY`: _OPTIONAL_; the repository to update its readme; defaults to current repository\n\n### Features\n\n- Aggregates all user source repos (not forked or archived), and group them by specified provided Topics\n- Sort results based on number of Stars\n- Calculate relative time passed since last update\n- Update the target repository README with the generated content\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/screenshot.png\" width=\"600\" /\u003e\n\u003c/p\u003e\n\n---\n\n## Instructions\n\n- Add this comment somewhere in your `README.md`. You can find an example [here](https://github.com/metaory/metaory/blob/master/README.md?plain=1#L37).\n\n```\n\u003c!--START_SECTION:topics--\u003e\n\u003c!--END_SECTION:topics--\u003e\n```\n\n- Create a workflow file.\n\n`.github/workflows/readme-topics.yml`\n\n```yml\nname: readme-topics\nrun-name: Update README.md with repos categorized by topic\non:\n  schedule:\n    - cron: \"0 0 * * 0\"\n  workflow_dispatch:\njobs:\n  generate-topics:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: metaory/github-readme-topics-action@v1\n        env:\n          GH_PAT: ${{ secrets.GH_PAT }} # your personal-access-tokens with write permission\n        with:\n          # USERNAME: metaory # OPTIONAL; the committer username, defaults to repository owner (GITHUB_REPOSITORY_OWNER)\n          # REPOSITORY: playground # OPTIONAL; the repository name to update its readme, defaults to current repository (GITHUB_REPOSITORY)\n          EMAIL: metaory@gmail.com # REQUIRED; the committer email address\n          TOPICS: |- # REQUIRED; list of topics to group by\n            api\n            automation\n            challenge\n            cli\n            github-actions\n            npm-package\n            theme\n```\n\nThe above job runs every one week, you can change it as you wish based on the [cron syntax](https://jasonet.co/posts/scheduled-actions/#the-cron-syntax).\n\n---\n\n## TODO\n\n- [x] format relative date (update column)\n- [x] add links (name column)\n- [x] publish a tag release\n","funding_links":[],"categories":["JavaScript","Tools"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetaory%2Fgithub-readme-topics-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetaory%2Fgithub-readme-topics-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetaory%2Fgithub-readme-topics-action/lists"}