{"id":13423190,"url":"https://github.com/jamesgeorge007/github-activity-readme","last_synced_at":"2025-05-14T07:10:13.979Z","repository":{"id":38056869,"uuid":"280152958","full_name":"jamesgeorge007/github-activity-readme","owner":"jamesgeorge007","description":"Updates README with the recent GitHub activity of a user","archived":false,"fork":false,"pushed_at":"2025-02-22T15:02:04.000Z","size":397,"stargazers_count":869,"open_issues_count":9,"forks_count":233,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-05-07T23:34:44.339Z","etag":null,"topics":["activity","github-action","github-action-javascript","github-actions","github-workflow","hacktoberfest","hacktoberfest2020","javascript","profile-page","profile-readme","readme","readme-template"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/jamesgeorge007.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"zenodo":null}},"created_at":"2020-07-16T12:50:42.000Z","updated_at":"2025-05-07T21:08:32.000Z","dependencies_parsed_at":"2024-03-28T18:33:22.528Z","dependency_job_id":"53df5d1f-a5e7-4225-bc67-bc9ed276b283","html_url":"https://github.com/jamesgeorge007/github-activity-readme","commit_stats":{"total_commits":62,"total_committers":19,"mean_commits":3.263157894736842,"dds":0.4516129032258065,"last_synced_commit":"df57d5cab9b53277241f93190e176b38dd95eb1a"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesgeorge007%2Fgithub-activity-readme","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesgeorge007%2Fgithub-activity-readme/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesgeorge007%2Fgithub-activity-readme/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamesgeorge007%2Fgithub-activity-readme/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamesgeorge007","download_url":"https://codeload.github.com/jamesgeorge007/github-activity-readme/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253234155,"owners_count":21875555,"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":["activity","github-action","github-action-javascript","github-actions","github-workflow","hacktoberfest","hacktoberfest2020","javascript","profile-page","profile-readme","readme","readme-template"],"created_at":"2024-07-30T23:01:09.209Z","updated_at":"2025-05-14T07:10:08.963Z","avatar_url":"https://github.com/jamesgeorge007.png","language":"JavaScript","readme":"# GitHub Activity in Readme\n\nUpdates `README.md` with the recent GitHub activity of a user.\n\n\u003cimg width=\"735\" alt=\"profile-repo\" src=\"https://user-images.githubusercontent.com/25279263/87703301-3aa4a500-c7b8-11ea-8eb6-245121997a7b.png\"\u003e\n\n---\n\n## Instructions\n\n- Add the comment `\u003c!--START_SECTION:activity--\u003e` (entry point) within `README.md`. You can find an example [here](https://github.com/jamesgeorge007/jamesgeorge007/blob/master/README.md).\n\n- It's the time to create a workflow file.\n\n`.github/workflows/update-readme.yml`\n\n```yml\nname: Update README\non:\n  schedule:\n    - cron: \"*/30 * * * *\"\n  workflow_dispatch:\njobs:\n  build:\n    name: Update this repo's README with recent activity\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n\n    steps:\n      - uses: actions/checkout@v4\n      - uses: jamesgeorge007/github-activity-readme@master\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\nThe above job runs every half an hour, you can change it as you wish based on the [cron syntax](https://jasonet.co/posts/scheduled-actions/#the-cron-syntax).\n\nPlease note that only those public events that belong to the following list show up:-\n\n- `IssueEvent`\n- `ReleaseEvent`\n- `IssueCommentEvent`\n- `PullRequestEvent`\n\nYou can find an example [here](https://github.com/jamesgeorge007/jamesgeorge007/blob/master/.github/workflows/update-readme.yml).\n\n### Override defaults\n\nUse the following `input params` to customize it for your use case:-\n\n| Input Param        | Default Value                                                            | Description                                               |\n| ------------------ | ------------------------------------------------------------------------ | --------------------------------------------------------- |\n| `GH_USERNAME`      | Your GitHub username                                                     | Username for which to generate the activity overview      |\n| `COMMIT_NAME`      | github-actions[bot]                                                      | Name of the committer                                     |\n| `COMMIT_EMAIL`     | 41898282+github-actions[bot]@users.noreply.github.com                    | Email of the committer                                    |\n| `COMMIT_MSG`       | :zap: Update README with the recent activity                             | Commit message used while committing to the repo          |\n| `EMPTY_COMMIT_MSG` | :memo: empty commit to keep workflow active after 60 days of no activity | Commit message used when there are no updates             |\n| `MAX_LINES`        | 5                                                                        | The maximum number of lines populated in your readme file |\n| `TARGET_FILE`      | README.md                                                                | The file to insert recent activity into                   |\n\n```yml\nname: Update README\non:\n  schedule:\n    - cron: \"*/30 * * * *\"\n  workflow_dispatch:\njobs:\n  build:\n    name: Update this repo's README with recent activity\n    runs-on: ubuntu-latest\n    permissions:\n      contents: write\n\n    steps:\n      - uses: actions/checkout@v4\n      - uses: jamesgeorge007/github-activity-readme@master\n        env:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        with:\n          COMMIT_MSG: \"Specify a custom commit message\"\n          MAX_LINES: 10\n          COMMIT_NAME: GitHub Activity Readme\n```\n\n_Inspired by [JasonEtco/activity-box](https://github.com/JasonEtco/activity-box)_\n","funding_links":[],"categories":["Tools","JavaScript","Github README PROFILE CATEGORY","GitHub Actions for Readmes","🛠️ Widgets 👇","Dynamic Content","javascript","Resources"],"sub_categories":["Dynamic Badges","Images Gifs:","Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamesgeorge007%2Fgithub-activity-readme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamesgeorge007%2Fgithub-activity-readme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamesgeorge007%2Fgithub-activity-readme/lists"}