Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/my-badges/my-badges
All You Badges
https://github.com/my-badges/my-badges
github github-profile hacktoberfest profile profile-readme
Last synced: 3 months ago
JSON representation
All You Badges
- Host: GitHub
- URL: https://github.com/my-badges/my-badges
- Owner: my-badges
- License: mit
- Created: 2023-10-04T13:56:00.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-10T20:59:48.000Z (6 months ago)
- Last Synced: 2024-10-02T07:09:43.717Z (4 months ago)
- Topics: github, github-profile, hacktoberfest, profile, profile-readme
- Language: TypeScript
- Homepage:
- Size: 11.4 MB
- Stars: 84
- Watchers: 2
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-ccamel - my-badges/my-badges - Google's Moma Badges for GitHub (TypeScript)
- awesome-readme-tools - My Badges - 💎 Funny badges. Similar to GitHub Achievements, but users can define own badges. (Badges)
README
# My Badges
— _Do you like GitHub Achievements?_
— _Do you want to get more badges?_
— _We got you covered!_
**My Badges** is a GitHub Action that generates badges for your profile README.md.
Badges will be updated automatically every day. And you will get new badges as you progress, or
as community adds new badges. **Yes, you can [add your own badges](CONTRIBUTING.md)!**
But how does those badges look like? Take a look [here](https://github.com/antonmedv),
or [here](https://github.com/antongolub).
## Installation
Create `your-username/your-username` [GH profile repository](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme).
Add the following code somewhere in `README.md`:
```html
```
Add the following workflow `.github/workflows/my-badges.yml` to your repository:
```yaml
name: my-badges
on:
workflow_dispatch:
schedule:
- cron: '0 0 * * *'
permissions:
contents: write
jobs:
my-badges:
runs-on: ubuntu-latest
steps:
- name: Update My Badges
run: npx update-my-badges ${{github.repository_owner}}
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
> [!NOTE]
> You don't need to create a `GITHUB_TOKEN` in repository. The workflow will use a default runner token.
Start **my-badges** workflow, or wait for it to run automatically.
## Configuration
| Param | ENV alias | Description | Default |
|---------|----------------|--------------------------------|---------------|
| `token` | `GITHUB_TOKEN` | Auth token | |
| `user` | `GITHUB_USER` | Username | |
| `repo` | `GITHUB_REPO` | Repository name to push badges | `{user/user}` |
Additional params
| Param | Description | Default |
|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| `data` | Path to JSON to generate badges. If empty, required data will be obtained from the GH API | |
| `size` | Badge size for README.md, px | 64 |
| `dryrun` | Generate badges, but skip pushing them to git | |
| `pick` | List of badges to pick. Pass `--pick="a-commit,ab-commit,revert-revert-commit"` to generate only the specified entries. If empty gets all of them | |
| `omit` | List of badges to exclude. For example, if you're too shy to flex your stars: `--omit:stars-100,stars-500,stars-1000` or even shorter `--omit:stars-*` | |
| `compact` | Represent the highest tier badges in README.md. For example, If you have both `stars-100` and `stars-500` achievements, only the last one will be shown | |
### Manual Run
```sh
npx update-my-badges
```
## License
[MIT](LICENSE)