https://github.com/offensive-vk/auto-contributions
A Github Action that generates the Contributions, Coding Style, Most Used Languages of a Github User in SVG Format.
https://github.com/offensive-vk/auto-contributions
automation contribution github-action profile svg
Last synced: 3 months ago
JSON representation
A Github Action that generates the Contributions, Coding Style, Most Used Languages of a Github User in SVG Format.
- Host: GitHub
- URL: https://github.com/offensive-vk/auto-contributions
- Owner: offensive-vk
- License: mit
- Created: 2024-11-24T16:50:13.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-03-09T15:01:12.000Z (4 months ago)
- Last Synced: 2025-03-28T19:13:17.181Z (3 months ago)
- Topics: automation, contribution, github-action, profile, svg
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/auto-3d-contributions
- Size: 3.78 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# π Auto Contributions - Profile 3D SVGs π
[π―π΅ ζ₯ζ¬θͺ](./docs/README.ja-jp.md) | [πͺπΈ EspaΓ±ol](./docs/README.es-es.md)
## π Overview
This GitHub Action π οΈ creates an eye-catching **3D contribution calendar** ποΈ for your GitHub profile π¨.
## π How to Use (GitHub Actions) - Basic
This action generates a **3D contribution calendar** for your profile and automatically commits the SVG to your repository π€. You can also manually trigger it if needed π.
### π οΈ Step 1. Create a Special Repository
Create a repository on GitHub named after your username π.
For example:
- If your username is `mona`, create a repository named `mona/mona`.
π Reference: [Managing Your Github Profile Readme](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme).
---
### π οΈ Step 2. Create a Workflow File
Create the following workflow file at `.github/workflows/contributions.yml`:
```yaml
name: Auto Contributions
on:
schedule:
- cron: "0 8 * * *" # Adjust the time as per your preference.
workflow_dispatch:
jobs:
generate:
runs-on: ubuntu-latest
name: Generate 3D Profile SVGs
steps:
- uses: actions/checkout@v4
- uses: ./
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
USERNAME: ${{ github.repository_owner }}
- name: Commit & Push
run: |
git config user.name ${{ github.actor }}
git config user.email ${{ github.actor }}@users.noreply.github.com
git add .
git commit -m "Updated 3D Profile SVGs."
git push
```
π‘ **Tip:** If you want to include private repositories, generate a **personal access token** π and set it to `GITHUB_TOKEN`.
---
### π οΈ Step 3. Manually Launch the Action
Navigate to:
`Actions` β `GitHub-Profile-3D-Contrib` β `Run workflow`.
The following profile images will be generated:
π **Generated Files:**
- `profile-3d-contrib/profile-green-animate.svg`
- `profile-3d-contrib/profile-season-animate.svg`
- `profile-3d-contrib/profile-night-view.svg`
- `profile-3d-contrib/profile-gitblock.svg`
(*and more variations!*)
If you specify a custom `SETTING_JSON`, a unique image will be generated:
- `profile-3d-contrib/profile-customize.svg`
---
### π οΈ Step 4. Add the Generated Image to Your README
Add the generated SVG to your profile README π:
```md
```
---
## π¨ Demo
Here are some examples of the stunning 3D contribution SVGs this action generates:
- **Green Animated Version:**
- **Season (Northern Hemisphere):**
- **Night View Version:**
---
## π₯οΈ How to Use (Local)
You can also generate the 3D contribution calendar locally:
1. Set the `GITHUB_TOKEN` environment variable with your **personal access token**:
```bash
export GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXX
```
2. Run the script using your GitHub username:
```bash
npm run build
node . YOUR_USERNAME
```
---
## π License
This project is licensed under the **MIT License**. π
---
Β© Vedansh 2020 - Present
Licensed under MIT
Thanks for visiting :)