Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/metaory/github-readme-topics-action
:pushpin: GitHub Action to update GitHub profile README.md with categorized repos based on their Topics
https://github.com/metaory/github-readme-topics-action
automation github-actions github-readme github-readme-profile github-readme-stats profile profile-readme profile-readme-generator
Last synced: 17 days ago
JSON representation
:pushpin: GitHub Action to update GitHub profile README.md with categorized repos based on their Topics
- Host: GitHub
- URL: https://github.com/metaory/github-readme-topics-action
- Owner: metaory
- License: mit
- Created: 2023-08-04T17:19:05.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-06-27T08:14:38.000Z (5 months ago)
- Last Synced: 2024-10-31T10:51:22.663Z (20 days ago)
- Topics: automation, github-actions, github-readme, github-readme-profile, github-readme-stats, profile, profile-readme, profile-readme-generator
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/github-readme-topics-action
- Size: 1.94 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# GitHub Profile Readme Topics Action
:pushpin: GitHub Action to update GitHub profile README.md with categorized repos based on their Topics
---
### Inputs
- `TOPICS`: list of topics to categorize repos by
- `EMAIL`: git user email address
- `USERNAME`: _OPTIONAL_; git username; defaults to repository owner
- `REPOSITORY`: _OPTIONAL_; the repository to update its readme; defaults to current repository
### Features
- Aggregates all user source repos (not forked or archived), and group them by specified provided Topics
- Sort results based on number of Stars
- Calculate relative time passed since last update
- Update the target repository README with the generated content
---
---
## Instructions
- 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).
```
```
- Create a workflow file.
`.github/workflows/readme-topics.yml`
```yml
name: readme-topics
run-name: Update README.md with repos categorized by topic
on:
schedule:
- cron: "0 0 * * 0"
workflow_dispatch:
jobs:
generate-topics:
runs-on: ubuntu-latest
steps:
- uses: metaory/github-readme-topics-action@v1
env:
GH_PAT: ${{ secrets.GH_PAT }} # your personal-access-tokens with write permission
with:
# USERNAME: metaory # OPTIONAL; the committer username, defaults to repository owner (GITHUB_REPOSITORY_OWNER)
# REPOSITORY: playground # OPTIONAL; the repository name to update its readme, defaults to current repository (GITHUB_REPOSITORY)
EMAIL: [email protected] # REQUIRED; the committer email address
TOPICS: |- # REQUIRED; list of topics to group by
api
automation
challenge
cli
github-actions
npm-package
theme
```
The 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).
---
## TODO
- [x] format relative date (update column)
- [x] add links (name column)
- [x] publish a tag release