{"id":13709544,"url":"https://github.com/teoxoy/profile-readme-stats","last_synced_at":"2025-04-05T05:06:44.475Z","repository":{"id":38282787,"uuid":"280606117","full_name":"teoxoy/profile-readme-stats","owner":"teoxoy","description":"Showcase your github stats on your profile README.md","archived":false,"fork":false,"pushed_at":"2023-12-08T04:26:36.000Z","size":165,"stargazers_count":242,"open_issues_count":2,"forks_count":83,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-23T01:32:28.433Z","etag":null,"topics":["github-actions","github-profile","profile-readme"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/profile-readme-stats","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/teoxoy.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":"2020-07-18T07:30:47.000Z","updated_at":"2024-06-23T07:41:46.786Z","dependencies_parsed_at":"2024-06-18T12:38:56.560Z","dependency_job_id":null,"html_url":"https://github.com/teoxoy/profile-readme-stats","commit_stats":{"total_commits":25,"total_committers":5,"mean_commits":5.0,"dds":0.52,"last_synced_commit":"f7a5b3b4c1c77d868a766abb3e0317688b276e40"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoxoy%2Fprofile-readme-stats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoxoy%2Fprofile-readme-stats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoxoy%2Fprofile-readme-stats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teoxoy%2Fprofile-readme-stats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teoxoy","download_url":"https://codeload.github.com/teoxoy/profile-readme-stats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289428,"owners_count":20914464,"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-actions","github-profile","profile-readme"],"created_at":"2024-08-02T23:00:41.166Z","updated_at":"2025-04-05T05:06:44.449Z","avatar_url":"https://github.com/teoxoy.png","language":"TypeScript","funding_links":[],"categories":["GitHub Actions for Readmes","TypeScript","🛠️ Widgets 👇"],"sub_categories":[],"readme":"# Profile Readme Stats\n\nShowcase your github stats on your profile README.md.\n\nThis action provides [template strings](#template-strings) that are replaced with their respective values when the action runs.\n\n**Example:** [TEMPLATE](./TEMPLATE.md?raw=true) → [README](./OUTPUT.md)\n\n## Table of contents\n\n\u003c!-- prettier-ignore-start --\u003e\n- [Profile Readme Stats](#profile-readme-stats)\n  - [Table of contents](#table-of-contents)\n  - [Action Inputs](#action-inputs)\n    - [`token`](#token)\n    - [`template`](#template)\n    - [`readme`](#readme)\n    - [`includeForks`](#includeforks)\n  - [Template Strings](#template-strings)\n    - [General](#general)\n      - [`{{ ACCOUNT_AGE }}`](#-account_age-)\n      - [`{{ ISSUES }}`](#-issues-)\n      - [`{{ PULL_REQUESTS }}`](#-pull_requests-)\n      - [`{{ CODE_REVIEWS }}`](#-code_reviews-)\n      - [`{{ COMMITS }}`](#-commits-)\n      - [`{{ GISTS }}`](#-gists-)\n      - [`{{ REPOSITORIES }}`](#-repositories-)\n      - [`{{ REPOSITORIES_CONTRIBUTED_TO }}`](#-repositories_contributed_to-)\n      - [`{{ STARS }}`](#-stars-)\n    - [Languages](#languages)\n      - [`{{ LANGUAGE_TEMPLATE_START }}`](#-language_template_start-)\n      - [`{{ LANGUAGE_NAME }}`](#-language_name-)\n      - [`{{ LANGUAGE_PERCENT }}`](#-language_percent-)\n      - [`{{ LANGUAGE_COLOR }}`](#-language_color-)\n      - [`{{ LANGUAGE_TEMPLATE_END }}`](#-language_template_end-)\n    - [Extra Options](#extra-options)\n      - [`uri`](#uri)\n      - [`max`](#max)\n  - [Example Workflow](#example-workflow)\n\u003c!-- prettier-ignore-end --\u003e\n\n## Action Inputs\n\n### `token`\n\n_Required_\n\nPersonal access token with `read:user` scope and optional `repo` scope\n\nGenerate token here: https://github.com/settings/tokens\n\n**Note:** `repo` scope is needed for taking private repositories into account\n\n### `template`\n\nPath to template file (default: `./TEMPLATE.md`)\n\n### `readme`\n\nPath to generated file (default: `./README.md`)\n\n### `includeForks`\n\nInclude forked repositories when calculating the stats (default: `false`)\n\n## Template Strings\n\n### General\n\n#### `{{ ACCOUNT_AGE }}`\n\nAccount age in years.\n\n#### `{{ ISSUES }}`\n\nTotal number of opened issues across all repositories.\n\n#### `{{ PULL_REQUESTS }}`\n\nTotal number of opened pull requests across all repositories.\n\n#### `{{ CODE_REVIEWS }}`\n\nTotal number of pull requests reviewed across all repositories.\n\n#### `{{ COMMITS }}`\n\nTotal number of commits across all repositories. Includes commits in private repositories only if you allowed github to show your private contributions on your profile (check out this [link](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile#changing-the-visibility-of-your-private-contributions) for more info).\n\n#### `{{ GISTS }}`\n\nTotal number of public gists.\n\n#### `{{ REPOSITORIES }}`\n\nTotal number of repositories. Includes private repositories if the given personal access token has `repo` scope (see more [here](#token)).\n\n#### `{{ REPOSITORIES_CONTRIBUTED_TO }}`\n\nTotal number of repositories you contributed to.\n\n#### `{{ STARS }}`\n\nTotal number of stars on all your gists and repositories.\n\n### Languages\n\nA region that will be repeated for every language you use in your repositories.\n\n#### `{{ LANGUAGE_TEMPLATE_START }}`\n\nSpecial template string that signifies the start of the region.\n\n#### `{{ LANGUAGE_NAME }}`\n\nName of the language.\n\n#### `{{ LANGUAGE_PERCENT }}`\n\nHow often the language is used in your repositories (percentage wise).\n\n#### `{{ LANGUAGE_COLOR }}`\n\nColor of the language (in CSS color format ex: `#0248AC`).\n\n#### `{{ LANGUAGE_TEMPLATE_END }}`\n\nSpecial template string that signifies the end of the region.\n\n### Extra Options\n\n#### `uri`\n\nWill encode the value as an URI component\n\n**Example:**\n\n```\n{{ LANGUAGE_COLOR:uri }}\n```\n\n#### `max`\n\nCan only be used with `LANGUAGE_TEMPLATE_START`\n\nWill run the inner template at most `max` nr of times\n\n**Example:**\n\n```\n{{ LANGUAGE_TEMPLATE_START:max=5 }}\nThis text will be printed at most 5 times\n{{ LANGUAGE_TEMPLATE_END }}\n```\n\n## Example Workflow\n\n\u003c!-- prettier-ignore-start --\u003e\n```yml\non:\n  schedule:\n    - cron: '0 */12 * * *' # every 12 hours\n  push:\n    branches:\n      - master\n      - main\njobs:\n  publish:\n    runs-on: ubuntu-latest\n    steps:\n    - uses: actions/checkout@v4\n      with:\n        fetch-depth: 0\n    - name: Generate README.md\n      uses: teoxoy/profile-readme-stats@v3\n      with:\n        token: ${{ secrets.USER_TOKEN }}\n    - name: Update README.md\n      run: |\n        if [[ \"$(git status --porcelain)\" != \"\" ]]; then\n        git config user.name github-actions[bot]\n        git config user.email 41898282+github-actions[bot]@users.noreply.github.com\n        git add .\n        git commit -m \"Update README\"\n        git push\n        fi\n```\n\u003c!-- prettier-ignore-end --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteoxoy%2Fprofile-readme-stats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteoxoy%2Fprofile-readme-stats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteoxoy%2Fprofile-readme-stats/lists"}