Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/varunsridharan/action-repository-roster
Shout-out supporters in your GitHub README file.
https://github.com/varunsridharan/action-repository-roster
action action-roster action-units actions community fork github github-action github-actions roster rosters shoutout stars
Last synced: 8 days ago
JSON representation
Shout-out supporters in your GitHub README file.
- Host: GitHub
- URL: https://github.com/varunsridharan/action-repository-roster
- Owner: varunsridharan
- License: mit
- Created: 2020-11-01T00:57:28.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-27T18:39:59.000Z (almost 3 years ago)
- Last Synced: 2024-11-17T08:44:31.680Z (about 1 month ago)
- Topics: action, action-roster, action-units, actions, community, fork, github, github-action, github-actions, roster, rosters, shoutout, stars
- Language: PHP
- Homepage:
- Size: 994 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
~ Shout-out supporters in your GitHub README file. ~
## š Usage
1. [Setup Action Workflow File](#-github-action-workflow-file)
2. Update Your `README.md` with below code
***Repository Stargazers***
```markdown
## ā³ Stargazers
```
***Repository Forks***
```markdown
## ā³ Forkers
```
> :information_source: Currently there are ways to auto trigger the workflow when a users **stars** / **forks** the repository.
>
> :information_source: Using this action with the workflow trigger [fork](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#fork) & [watch](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#watch) is the best optmized way.
>
> if you want to remove users that have un-stared / deleted the fork then you might have to use [cron](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#schedule) to handle it
---
## āļø Configuration
Option
Description
Default
General Config
IMAGE_SAVE_PATH
Custom location on where to save generated SVG image file.
Image Files Are Generated When Output Type Set To image
.github/roster/
Forks Config
FORK
Set to true to generate latest forked users information. or provide a file location to update the information
If its set to FALSE the forked users information will not be generated
README.md
FORK_OUTPUT_TYPE
this can be set to either table, list OR image
markdown
FORK_OUTPUT_STYLE
Please Refer :paintbrush: Styling Options Below
table
FORK_COUNTS
No of latest forked users to generate
7
FORK_DESCRIPTION
set to true to show default description after Forks users information.
or you can also provide your custom text to show after the Forks users information.
if its set to FALSE description will not be generated
true
Stars Config
STARS
Set to true to generate latest Stargazers users information. or provide a file location to update the information
If its set to FALSE the Stargazers users information will not be generated
README.md
STARS_OUTPUT_TYPE
this can be set to either table, list OR image
markdown
STARS_OUTPUT_STYLE
Please Refer :paintbrush: Styling Options Below
table
STARS_COUNTS
No of latest Stargazers users to generate
7
STARS_DESCRIPTION
set to true to show default description after Stargazers users information.
or you can also provide your custom text to show after the Stargazers users information.
if its set to FALSE description will not be generated
true
### :paintbrush: Styling Options
Option
Description
Output Types
Image
Table
List
no-image
User's avatar will not be rendered
ā
ā
ā
img-smooth
User's avatar will slightly rounded
ā
ā
ā
img-rounded
User's avatar will rounded
ā
ā
ā
img-small
User's avatar will be set to small size
ā
ā
ā
img-large
User's avatar will be set to large size
ā
ā
ā
no-name
User's name will not be rendered
ā
ā
ā
no-link
Link to users github profile will not be added
ā
ā
ā
list-ordered
HTML list will be ordered
ā
ā
ā
bold
username text will be rendered in bold text
ā
ā
ā
italic
username text will be rendered in italic text
ā
ā
ā
small
username text will be rendered in small fontsize text
ā
ā
ā
> You can provide multiple styles in `*_OUTPUT_STYLE` by entering `,` separated | Example : `img-small,bold,italic`
#### Example Code
```yaml
# Below Will Render Stargazers Data In HTML Table With small user avatar
STARS_OUTPUT_TYPE: 'table' # Possible Options [ image , table , list ]
STARS_OUTPUT_STYLE: 'img-small'
# Below Will Render Fork's Data In SVG Image with small user avatar & user's name hidden
FORK_OUTPUT_TYPE: 'image' # Possible Options [ image , table , list ]
FORK_OUTPUT_STYLE: 'img-small,no-name'
```
## š Github Action Workflow File
```yml
name: "š Repository Roster"
on:
workflow_dispatch:
watch:
types:
- started
fork:
jobs:
update_latest_roster:
if: github.repository == 'varunsridharan/action-repository-roster'
name: "š Update Latest Roster"
runs-on: ubuntu-latest
steps:
- name: "š„ Fetching Repository Contents"
uses: actions/checkout@main
- name: "š Markdown - Repository Roster"
uses: "varunsridharan/action-repository-roster@main"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## š Live Examples (for this repo)
### ā³ Stargazers
2 have starred this repository
### ā³ Forkers
2 have forked this repository
For Styling Demo Please Check Examples Directory
---
## š Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
[Checkout CHANGELOG.md](https://github.com/varunsridharan/action-repository-roster/blob/main/CHANGELOG.md)
## š¤ Contributing
If you would like to help, please take a look at the list of [issues](https://github.com/varunsridharan/action-repository-roster/issues/).
## š License & Conduct
- [**MIT License**](https://github.com/varunsridharan/action-repository-roster/blob/main/LICENSE) Ā© [Varun Sridharan](website)
- [Code of Conduct](https://github.com/varunsridharan/.github/blob/master/CODE_OF_CONDUCT.md)
## š£ Feedback
- ā This repository if this project helped you! :wink:
- Create An [š§ Issue](https://github.com/varunsridharan/action-repository-roster/issues/) if you need help / found a bug
## š° Sponsor
[I][twitter] fell in love with open-source in 2013 and there has been no looking back since! You can read more about me [here][website].
If you, or your company, use any of my projects or like what Iām doing, kindly consider backing me. I'm in this for the long run.
- ā How about we get to know each other over coffee? Buy me a cup for just [**$9.99**][buymeacoffee]
- āļøāļø How about buying me just 2 cups of coffee each month? You can do that for as little as [**$9.99**][buymeacoffee]
- š° We love bettering open-source projects. Support 1-hour of open-source maintenance for [**$24.99 one-time?**][paypal]
- š Love open-source tools? Me too! How about supporting one hour of open-source development for just [**$49.99 one-time ?**][paypal]
[paypal]: https://sva.onl/paypal
[buymeacoffee]: https://sva.onl/buymeacoffee
[twitter]: https://sva.onl/twitter/
[website]: https://sva.onl/website/
## Connect & Say š
- **Follow** me on [šØāš» Github][github] and stay updated on free and open-source software
- **Follow** me on [š¦ Twitter][twitter] to get updates on my latest open source projects
- **Message** me on [š Telegram][telegram]
- **Follow** my pet on [Instagram][sofythelabrador] for some _dog-tastic_ updates!
[sofythelabrador]: https://www.instagram.com/sofythelabrador/
[github]: https://sva.onl/github/
[twitter]: https://sva.onl/twitter/
[telegram]: https://sva.onl/telegram/
---
Built With ā„ By Varun Sridharan
---
