{"id":13474396,"url":"https://github.com/yoshi389111/github-profile-3d-contrib","last_synced_at":"2025-05-15T08:06:09.938Z","repository":{"id":39376031,"uuid":"365531235","full_name":"yoshi389111/github-profile-3d-contrib","owner":"yoshi389111","description":"This GitHub Action creates a GitHub contribution calendar on a 3D profile image.","archived":false,"fork":false,"pushed_at":"2024-05-11T16:10:49.000Z","size":30491,"stargazers_count":1084,"open_issues_count":19,"forks_count":179,"subscribers_count":9,"default_branch":"main","last_synced_at":"2024-10-30T07:47:45.934Z","etag":null,"topics":["github-action","github-contribution-graph","github-contributions","github-profile","github-profile-readme","profile-readme"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yoshi389111.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGE_LOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-05-08T14:12:59.000Z","updated_at":"2024-10-28T19:47:11.000Z","dependencies_parsed_at":"2024-01-14T08:09:42.185Z","dependency_job_id":"5262f445-c668-4dcd-ad0b-b961abdb76b2","html_url":"https://github.com/yoshi389111/github-profile-3d-contrib","commit_stats":{"total_commits":125,"total_committers":5,"mean_commits":25.0,"dds":0.04800000000000004,"last_synced_commit":"6698930b81f5fcc3b6e92fbc5501b9b648f068bc"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshi389111%2Fgithub-profile-3d-contrib","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshi389111%2Fgithub-profile-3d-contrib/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshi389111%2Fgithub-profile-3d-contrib/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yoshi389111%2Fgithub-profile-3d-contrib/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yoshi389111","download_url":"https://codeload.github.com/yoshi389111/github-profile-3d-contrib/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248869891,"owners_count":21174947,"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-action","github-contribution-graph","github-contributions","github-profile","github-profile-readme","profile-readme"],"created_at":"2024-07-31T16:01:12.048Z","updated_at":"2025-05-15T08:06:09.928Z","avatar_url":"https://github.com/yoshi389111.png","language":"TypeScript","readme":"# GitHub Profile 3D Contrib.\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg)\n\n[日本語](./docs/README.ja-jp.md) | [Español](./docs/README.es-es.md)\n\n## Overview\n\nThis GitHub Action creates a GitHub contribution calendar on a 3D profile image.\n\n## How to use (GitHub Actions) - Basic\n\nThis action generate your github profile 3d contribute calendar and make a commit to your repo.\nYou can also trigger action by yourself after add this action.\n\n### step 1. Create special repository.\n\nCreate a repository on GitHub with the same name as your user name.\n\n* e.g. If the user name is `octocat`, create a repository named `octocat/octocat`.\n* ref. [Managing your profile README](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme)\n\nIn this repository, do the following.\n\n### step 2. Create workflow file.\n\nCreate a workflow file like the one below.\n\n* `.github/workflows/profile-3d.yml`\n\nThe schedule is set to start once a day.\nPlease correct the startup time to a convenient time.\n\n```yaml:.github/workflows/profile-3d.yml\nname: GitHub-Profile-3D-Contrib\n\non:\n  schedule: # 03:00 JST == 18:00 UTC\n    - cron: \"0 18 * * *\"\n  workflow_dispatch:\n\npermissions:\n  contents: write\n\njobs:\n  build:\n    runs-on: ubuntu-latest\n    name: generate-github-profile-3d-contrib\n    steps:\n      - uses: actions/checkout@v4\n      - uses: yoshi389111/github-profile-3d-contrib@latest\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n          USERNAME: ${{ github.repository_owner }}\n      - name: Commit \u0026 Push\n        run: |\n          git config user.name github-actions\n          git config user.email github-actions@github.com\n          git add -A .\n          if git commit -m \"generated\"; then\n            git push\n          fi\n```\n\nNote: If you also want to include the private repository, register the \"personal access token\" in the repository and set it to GITHUB_TOKEN specified in the workflow file.\n\nThis will add the action to the repository.\n\n#### Environment variables\n\n* `GITHUB_TOKEN` : (required) access token\n* `USERNAME` : (required) target user name (or specify with an argument).\n* `MAX_REPOS` : (optional) max repositories, default 100 - since ver. 0.2.0\n* `SETTING_JSON` : (optional) settings json file path. See `sample-settings/*.json` and `src/type.ts` in `yoshi389111/github-profile-3d-contrib` repository for details. - since ver. 0.6.0\n* `GITHUB_ENDPOINT` : (optional) Github GraphQL endpoint. e.g. `https://github.mycompany.com/api/graphql` - since ver. 0.8.0\n* `YEAR` : (optional) For past calendars, specify the year. - since ver. 0.8.0\n\n#### About `GITHUB_TOKEN`\n\nThe `secrets.GITHUB_TOKEN` set in the `GITHUB_TOKEN` environment variable in the sample is a special access token automatically created by GitHub.\n\n- GitHub Docs: [Automatic token authentication](https://docs.github.com/en/actions/security-for-github-actions/security-guides/automatic-token-authentication)\n\nIf you want to generate a contribution calendar for public repositories only, register this value.\nThere is no need to create a secret manually.\n\nAlso, if you want to include activity in your private repositories in your contribution calendar, check \"Include private contributions on my profile\" in the \"Profile settings\" section of \"Public profile\" in your user settings.\n\nFurthermore, if you want to aggregate language information from private repositories, create an access token with the appropriate permissions.\nRegister that access token as a secret with any name you like (For example, `MY_PERSONAL_ACCESS_TOKEN`).\nHowever, please note that user-created secrets cannot start with `GITHUB_`.\n\n- GitHub Docs: [About secrets](https://docs.github.com/en/actions/security-for-github-actions/security-guides/about-secrets)\n\nSpecify that secret in the `GITHUB_TOKEN` environment variable.\n\n```diff\n          env:\n-           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n+           GITHUB_TOKEN: ${{ secrets.MY_PERSONAL_ACCESS_TOKEN }}\n            USERNAME: ${{ github.repository_owner }}\n```\n\n#### About the time to schedule\n\nIn the sample, it is set to start at 18:00 UTC.\nThis is because it will run at midnight JST, which is the author's local time.\n\n```yaml\non:\n  schedule: # 03:00 JST == 18:00 UTC\n    - cron: \"0 18 * * *\"\n```\n\nFeel free to change it to any time you like when actually using it.\nHowever, please note that it must be specified in UTC.\n\n### step 3. Manually launch the action\n\nLaunch the added action.\n\n* `Actions` -\u003e `GitHub-Profile-3D-Contrib` -\u003e `Run workflow`\n\nThe profile image is generated with the following paths.\n\n* `profile-3d-contrib/profile-green-animate.svg`\n* `profile-3d-contrib/profile-green.svg`\n* `profile-3d-contrib/profile-season-animate.svg`\n* `profile-3d-contrib/profile-season.svg`\n* `profile-3d-contrib/profile-south-season-animate.svg`\n* `profile-3d-contrib/profile-south-season.svg`\n* `profile-3d-contrib/profile-night-view.svg`\n* `profile-3d-contrib/profile-night-green.svg`\n* `profile-3d-contrib/profile-night-rainbow.svg`\n* `profile-3d-contrib/profile-gitblock.svg`\n\nAlternatively, if `SETTING_JSON` is specified, the following image will be generated.\n\n* `profile-3d-contrib/profile-customize.svg`\n\nexample: green version\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-green-animate.svg)\n\nexample: season version (Northern Hemisphere.)\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-season-animate.svg)\n\nexample: season version (Southern Hemisphere.)\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-south-season-animate.svg)\n\nexample: night view version\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-view.svg)\n\nexample: night green version\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-green.svg)\n\nexample: night rainbow version\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg)\n\nexample: git block version\n\n![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg)\n\n### step 4. Add image to README.md\n\nAdd the path of the generated image to the readme file.\n\ne.g.\n\n```md\n![](./profile-3d-contrib/profile-green-animate.svg)\n```\n\n## How to use (GitHub Actions) - Advanced examples\n\n#### [More info in EXAMPLES.md](./EXAMPLES.md)\n\n## How to use (local)\n\nSet the `GITHUB_TOKEN` environment variable to the value of \"personal access token\".\n\n```shell-session\nexport GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXX\n```\n\nRun it with your GitHub user specified.\n\n```shell-session\nnode_modules/.bin/ts-node src/index.ts USER_NAME\n```\n\nor\n\n```shell-session\nnpm run build\nnode . USER_NAME\n```\n\n\n## Licence\n\nMIT License\n\n(C) 2021 SATO, Yoshiyuki\n","funding_links":[],"categories":["TypeScript","others","🛠️ Widgets 👇","Widgets and Embeds"],"sub_categories":["Dynamic Badges"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoshi389111%2Fgithub-profile-3d-contrib","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyoshi389111%2Fgithub-profile-3d-contrib","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyoshi389111%2Fgithub-profile-3d-contrib/lists"}