https://github.com/anuraghazra/peerlist-profile-action
https://github.com/anuraghazra/peerlist-profile-action
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/anuraghazra/peerlist-profile-action
- Owner: anuraghazra
- License: mit
- Created: 2021-11-24T16:29:13.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-18T15:22:07.000Z (over 3 years ago)
- Last Synced: 2025-03-15T01:35:56.008Z (3 months ago)
- Language: TypeScript
- Size: 1.32 MB
- Stars: 30
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Peerlist Profile Action
Get dynamically generated peerlist.io profile overview on your readmes!
View Demo
·
Report Bug
·
Request Feature
Love the project? Please consider sponsoring to help it improve!
-------
A GitHub action to get [peerlist.io](https://peerlist.io) profile overview on your readmes.
[](https://peerlist.io/anuraghazra)
## Usage
see [action.yml](./action.yml)
Inside `.github/workflows` folder create a new workflow called `peerlist-overview.yml` and copy paste this content:
```yml
name: 'peerlist-overview'
on:
schedule:
# run every day at 12
- cron: "0 0 * * *"
jobs:
peerlist-run:
name: Generate peerlist overview
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: browser-actions/setup-chrome@latest
- uses: 'anuraghazra/peerlist-profile-action@master'
with:
token: ${{ secrets.GITHUB_TOKEN }}
username: 'anuraghazra' # your peerlist username
```
After running the action, it will automatically create a commit and upload it to the repo. And you can import that image to markdown.
> default output path is `./images/peerlist-profile.png` you can change it with by passing `output_path`
```md
[](https://peerlist.io/your_username)
```
## All options
- **username** - Peerlist username
- **output_path** - Output path to upload the image
- **card_size** - Card size (sm, md, lg) or any number
- **token** - GitHub access token
- **theme_name** - name of the theme, choose from all available themes
- **title_color** - Card's title color (without #)
- **text_color** - Body text color (without #)
- **bg_color** - Card's background color (without #)
- **branch** - Branch which you want to upload the image, change it depending on your main branch (default: main)
## Manual trigger example
If you wan't run the action with different parameters without chaning the workflow file everytime, you can make use of [workflow_dispatch](https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch) event.
See [demo action with workflow_dispatch](./.github/workflows/demo.yml)
-----
**Huge shoutout to peerlist.io for their amazing platform.**
Made with :heart: & TypeScript