{"id":20558636,"url":"https://github.com/rushabh-v/show-your-contributions","last_synced_at":"2025-04-14T13:43:11.555Z","repository":{"id":43543186,"uuid":"297039113","full_name":"rushabh-v/Show-Your-Contributions","owner":"rushabh-v","description":"An automated workflow that generates/updates an HTML doc to showcase your GitHub contributions.","archived":false,"fork":false,"pushed_at":"2024-05-26T19:37:12.000Z","size":147,"stargazers_count":35,"open_issues_count":2,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T02:47:09.433Z","etag":null,"topics":["github-contributions","github-pages","github-pages-website"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rushabh-v.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-20T09:06:30.000Z","updated_at":"2024-11-14T12:11:57.000Z","dependencies_parsed_at":"2022-09-13T05:52:41.268Z","dependency_job_id":null,"html_url":"https://github.com/rushabh-v/Show-Your-Contributions","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushabh-v%2FShow-Your-Contributions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushabh-v%2FShow-Your-Contributions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushabh-v%2FShow-Your-Contributions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rushabh-v%2FShow-Your-Contributions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rushabh-v","download_url":"https://codeload.github.com/rushabh-v/Show-Your-Contributions/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248890175,"owners_count":21178380,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-contributions","github-pages","github-pages-website"],"created_at":"2024-11-16T03:46:23.225Z","updated_at":"2025-04-14T13:43:11.511Z","avatar_url":"https://github.com/rushabh-v.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Show-Your-Contributions\n- An automated workflow that generates/updates your **GitHub page (Website)** and your **GitHub profile readme** to showcases your GitHub contributions.\n- It will check your activities every day at `00:00 UTC` and will automatically update the `contributrions.html` if it finds any new Contributions.\n\nSee it working: [GitHub page](https://rushabh-v.github.io/contributions) | [GitHub profile readme](https://github.com/rushabh-v/)\n\n\n![my-contribs](https://rushabh-v.github.io/images/my-contribs.png)\n\n## Usage Guide\n1. Generate a `Personal access token` from `Account settings -\u003e Developer settings -\u003e Personal access tokens`.\n2. Add a secret named `GIT_TOKEN` having your that `personal access token` from `repo settings -\u003e secrets -\u003e new secret` to the repo you want to add this workflow to.\n\n3. Go to `Actions -\u003e New workflow -\u003e set up a workflow yourself`, paste the following code snippet there, replace `PR_THRESHOLD` with your desired threshold, commit, and it will add a document named `contributions.html` in that repo which will automatically get updated on your new contributions (On the first occurrence of `00:00 UTC` after your contribution).\n\n- For profile readme setup, you can decide the `PR_THRESHOLD/minimum number of your PRs` for a repo to be included in your profile readme. That means you can set a number - `PR_THRESHOLD`, and all the repos to which you have made more than `PR_THRESHOLD` number of PRs will be added to the list of your contributions in your profile readme. **Any repo crossing the threshold will be automatically appended to your profile readme in the future.**\n\n\n**Note**: Replace`\u003cPR_THRESHOLD\u003e` on line 20 with your desired threshold to set up profile readme, Leave otherwise.\n\n```yml\nname: update-my-contributions\non:\n  push:\n   paths: \".github/workflows/*\"\n  schedule:\n   - cron: \"0 0 * * *\"\n\njobs:\n  main:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v1\n      - uses: actions/setup-node@v1\n      - name: Get Updates\n        run: |\n          sudo apt install python3-setuptools\n          git clone https://github.com/rushabh-v/Show-Your-Contributions\n          cp -r ./Show-Your-Contributions/* ./\n          pip3 install pygithub\n          python3 fetch_contribs.py ${{ secrets.GIT_TOKEN }}\n          python3 generate_doc.py ${{ secrets.GIT_TOKEN }} \u003cPR_THRESHOLD\u003e\n      - name: Commit\n        uses: test-room-7/action-update-file@v1\n        with:\n          file-path: |\n            contributions.html\n            contributions.png\n            total_contribs\n            profile_readme.txt\n          commit-msg: Update resources\n          github-token: ${{ secrets.GIT_TOKEN }}\n```\n\n### Profile readme setup\nAfter completing the above steps, paste the following line into your profile readme and replace `\u003cusername\u003e` with your username, and commit.\nOr you can find your personalized line in the file named `profile_readme.txt` in your GitHub pages' repo.\n\n```markdown\n[![My contributions](https://\u003cusername\u003e.github.io/contributions.png)](https://\u003cusername\u003e.github.io/contributions)\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frushabh-v%2Fshow-your-contributions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frushabh-v%2Fshow-your-contributions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frushabh-v%2Fshow-your-contributions/lists"}