{"id":32348119,"url":"https://github.com/mahyarmirrashed/action-github-readme-stats","last_synced_at":"2025-10-24T07:15:17.805Z","repository":{"id":268819625,"uuid":"905550596","full_name":"mahyarmirrashed/action-github-readme-stats","owner":"mahyarmirrashed","description":"GitHub action for adding statistics to your README.","archived":false,"fork":false,"pushed_at":"2025-04-04T01:27:23.000Z","size":236,"stargazers_count":8,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T02:27:30.816Z","etag":null,"topics":["github","readme","readme-stats"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mahyarmirrashed.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-19T04:03:43.000Z","updated_at":"2025-04-04T01:27:26.000Z","dependencies_parsed_at":"2024-12-19T05:20:50.028Z","dependency_job_id":"28699308-10fd-4ab0-beec-8f17765bf839","html_url":"https://github.com/mahyarmirrashed/action-github-readme-stats","commit_stats":null,"previous_names":["mahyarmirrashed/github-readme-stats","mahyarmirrashed/action-github-readme-stats"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/mahyarmirrashed/action-github-readme-stats","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahyarmirrashed%2Faction-github-readme-stats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahyarmirrashed%2Faction-github-readme-stats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahyarmirrashed%2Faction-github-readme-stats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahyarmirrashed%2Faction-github-readme-stats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mahyarmirrashed","download_url":"https://codeload.github.com/mahyarmirrashed/action-github-readme-stats/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mahyarmirrashed%2Faction-github-readme-stats/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280756267,"owners_count":26385296,"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","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","readme","readme-stats"],"created_at":"2025-10-24T07:15:14.641Z","updated_at":"2025-10-24T07:15:17.798Z","avatar_url":"https://github.com/mahyarmirrashed.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Readme Stats ๐Ÿ“Š\n\nThis project builds upon the previous work by Jainam Desai[^1]. Please consider\nstarring this repository if you find it useful! โญ๏ธ\n\n## Example Output\n\n```\n๐Ÿ•ฐ๏ธ I get my jam on during the evening!\n\n๐ŸŒž Morning \t180 commits\tโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t4.37%\n๐ŸŒ† Daytime \t881 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t21.38%\n๐ŸŒƒ Evening \t1619 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ\t39.30%\n๐ŸŒ™ Night \t1440 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘\t34.95%\n```\n\n```\n๐Ÿ“… I'm most productive on Saturdays!\n\nMonday \t666 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘\t16.17%\nTuesday \t635 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘\t15.41%\nWednesday \t500 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t12.14%\nThursday \t468 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t11.36%\nFriday \t485 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t11.77%\nSaturday \t750 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ\t18.20%\nSunday \t616 commits\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t14.95%\n```\n\n```\n๐Ÿงช Python for the win!\n\nPython \t21 repos\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆ\t15.22%\nHTML \t11 repos\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t7.97%\nC \t10 repos\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t7.25%\nMakefile \t10 repos\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t7.25%\nShell \t10 repos\tโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–ˆโ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘โ–‘\t7.25%\n```\n\n## Installation\n\nTo integrate this action into your repository, start by creating a GitHub Action\nworkflow file. In your repository, navigate to/create\n`.github/workflows/update-readme.yaml`.\n\n```yaml\nname: Update Readme\n\non:\n schedule:\n - cron: \"1 3 * * *\" # best to run at random time of day\n workflow_dispatch:\n\njobs:\n Update:\n name: Update Stats\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v2\n - uses: mahyarmirrashed/action-github-readme-stats@main # v1.0 and other tags exist, as well\n with:\n GITHUB_TOKEN: ${{ secrets.PAT }}\n TIMEZONE: \"America/Winnipeg\"\n FEATURES: \"DAY_STATS,WEEK_STATS,LANGUAGE_STATS\"\n - name: \"Commit changes\"\n run: |\n git config --global user.name \"github-actions[bot]\"\n git config --global user.email \"github-actions[bot]@users.noreply.github.com\"\n git add README.md\n git commit -m \"chore: update readme via actions\"\n git push\n```\n\nNext, generate a Personal Access Token (PAT) in your\n[GitHub Settings Page](https://github.com/settings/tokens). There, select the\n`Generate new token: fine-grained, repo-scoped` option.\n\nGive your token a name (e.g. \"Profile Stats\"), an expiration (e.g. 30 days), and\na description.\n\n\u003e [!IMPORTANT] \n\u003e For the permissions, you need to give access to `All repositories`, and\n\u003e selecting `read-only` `Contents` access for the `Repository Permissions`.\n\u003e Then, generate the token.\n\nOnce the token is generated, copy it, and create a new repository secret for\nyour repository. (It will be located at an address like\n`https://github.com/\u003cuser\u003e/\u003crepo\u003e/settings/secrets/actions`.) There, create a\nnew repository secret, name it `PAT`, and paste the generated token in the body!\n\n\u003e [!WARNING] \n\u003e Generally, it is not safe to give such encompassing permissions for a Personal\n\u003e Access Token, like `read` permissions for all repositories. However, there is\n\u003e \u003cins\u003eno other way\u003c/ins\u003e to get the statistics you desire without this\n\u003e permission.\n\u003e\n\u003e I created this GitHub action to keep the processing of this information local\n\u003e to GitHub's infrastructure (unlike WakaTime[^2]) to reduce potential attack\n\u003e surfaces.\n\n## Usage\n\nThis action operates by updating a specific section in your `README.md` file.\n\n### Adding the Markers\n\nInsert the following markers where you want the statistics to appear:\n\n```markdown\n\u003c!-- README-STATS:START --\u003e\n\n\u003c!-- README-STATS:END --\u003e\n```\n\nWhen the GitHub Action runs, it will populate the section between these markers\nwith your chosen statistics.\n\n### Example Configuration\n\nTo include daily, weekly, and language statistics, set the `FEATURES` parameter\nas follows:\n\n```yaml\nFEATURES: \"DAY_STATS,WEEK_STATS,LANGUAGE_STATS\"\n```\n\n## Configuration\n\nYou can customize the statistics included and their order by modifying the\n`FEATURES` parameter in your workflow file.\n\n### Available Includes\n\n- `DAY_STATS`: Commit statistics based on the time of day.\n- `WEEK_STATS`: Commit statistics based on the day of the week.\n- `LANGUAGE_STATS`: Programming language usage statistics.\n\n## Troubleshooting\n\n- **`README.md` Not Found:** Ensure that `README.md` exists in the root of your\n repository and that youโ€™ve added the `\u003c!-- README-STATS:START --\u003e` and\n `\u003c!-- README-STATS:END --\u003e` markers.\n- **Permissions Error:** Verify that your PAT has the necessary scopes (`repo`\n and `read:user`).\n- **Incorrect Timezone:** Make sure the timezone string is valid (e.g.,\n \"America/Winnipeg\").\n\n## Contributions\n\nContributions are welcome! Please open an issue or submit a pull request for any\nenhancements or bug fixes.\n\n[^1]: https://github.com/th3c0d3br34ker/github-readme-info\n\n[^2]: https://wakatime.com/plugins/status?onboarding=true\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmahyarmirrashed%2Faction-github-readme-stats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmahyarmirrashed%2Faction-github-readme-stats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmahyarmirrashed%2Faction-github-readme-stats/lists"}