{"id":23995542,"url":"https://github.com/TheDanniCraft/activity-log","last_synced_at":"2025-09-14T02:31:33.313Z","repository":{"id":250217281,"uuid":"833710441","full_name":"TheDanniCraft/activity-log","owner":"TheDanniCraft","description":"A GitHub Action that automatically updates your README file with the latest activity from your GitHub account. Customize the displayed events, set a limit on the number of events, and ignore specific event types. Ideal for keeping your personal README file current with recent contributions and changes.","archived":false,"fork":false,"pushed_at":"2025-09-12T21:02:47.000Z","size":418,"stargazers_count":8,"open_issues_count":2,"forks_count":53,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-12T23:36:55.750Z","etag":null,"topics":["activity","bun","github-action-javascript","github-actions","github-workflow","hacktoberfest","javascript","profile-page","profile-readme","readme","readme-profile"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/readme-activity-update","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/TheDanniCraft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-25T15:30:27.000Z","updated_at":"2025-09-12T21:02:53.000Z","dependencies_parsed_at":"2024-08-29T16:46:40.438Z","dependency_job_id":"e840c705-a3d9-4be2-9c81-609b6549abf1","html_url":"https://github.com/TheDanniCraft/activity-log","commit_stats":null,"previous_names":["thedannicraft/activity-log"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/TheDanniCraft/activity-log","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheDanniCraft%2Factivity-log","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheDanniCraft%2Factivity-log/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheDanniCraft%2Factivity-log/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheDanniCraft%2Factivity-log/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TheDanniCraft","download_url":"https://codeload.github.com/TheDanniCraft/activity-log/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TheDanniCraft%2Factivity-log/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275052448,"owners_count":25397153,"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-09-14T02:00:10.474Z","response_time":75,"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":["activity","bun","github-action-javascript","github-actions","github-workflow","hacktoberfest","javascript","profile-page","profile-readme","readme","readme-profile"],"created_at":"2025-01-07T22:00:33.978Z","updated_at":"2025-09-14T02:31:33.303Z","avatar_url":"https://github.com/TheDanniCraft.png","language":"JavaScript","funding_links":[],"categories":["GitHub Actions for Readmes"],"sub_categories":[],"readme":"\u003ch1 align=\"center\" id=\"title\"\u003eActivity Log\u003c/h1\u003e\r\n\r\n![activity log](https://socialify.git.ci/TheDanniCraft/activity-log/image?forks=1\u0026issues=1\u0026language=1\u0026logo=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F66677362\u0026name=1\u0026owner=1\u0026pattern=Solid\u0026pulls=1\u0026stargazers=1\u0026theme=Auto)\r\n\r\n\u003cp align=\"center\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/Made%20with%20Love%E2%9D%A4%EF%B8%8F-black?style=for-the-badge\" alt=\"made with love\"\u003e\r\n    \u003cimg src=\"https://img.shields.io/badge/Node.JS-node?style=for-the-badge\u0026amp;logo=nodedotjs\u0026amp;logoColor=white\u0026amp;color=%235FA04E\" alt=\"typescript\"\u003e\r\n\u003c/p\u003e\r\n\r\nA GitHub Action that automatically updates your README file with the latest activity from your GitHub account. Customize the displayed events, set a limit on the number of events, and ignore specific event types. Ideal for keeping your personal README file current with recent contributions and changes.\r\n\r\n## 🛠️Features\r\n\r\n- Customizable Event Limits\r\n- Event Filtering\r\n- Flexibility with Inputs\r\n\r\n## ✍️ Example\r\n\r\n\u003c!--START_SECTION:activity--\u003e\n1. 🗣 Commented on issue [#18](https://github.com/TheDanniCraft/clipify/issues/18) in [TheDanniCraft/clipify](https://github.com/TheDanniCraft/clipify): [View Comment](https://github.com/TheDanniCraft/clipify/issues/18#issuecomment-3285075808)\n2. 📝 Committed to [TheDanniCraft/clipify](https://github.com/TheDanniCraft/clipify/commit/e2813a8b22e039adabe3b68251cef417778da39f)\n3. 📝 Committed to a private repo\n4. 🔀 Merged a PR in a private repo\n5. 📝 Committed to a private repo\n6. 🔀 Merged a PR in a private repo\n7. 📝 Committed to [TheDanniCraft/clipify](https://github.com/TheDanniCraft/clipify/commit/1b083aae7533d58566b17862353cf3bc055e85ba)\n8. 📝 Committed to [TheDanniCraft/clipify](https://github.com/TheDanniCraft/clipify/commit/49e5486f7949a5fd64e81c986a35aed85156eed8)\n9. 📝 Committed to [TheDanniCraft/clipify](https://github.com/TheDanniCraft/clipify/commit/a4f2030ba8bd4f2d983f6b9eeb906d514a8d666a)\n10. 📥 Opened [PR #18](https://github.com/TheDanniCraft/clipify/pull/18) in [TheDanniCraft/clipify](https://github.com/TheDanniCraft/clipify)\n\u003c!--END_SECTION:activity--\u003e\r\n\r\n## 📖Usage\r\n\r\n### 1. Add Sections to `README.md`\r\n\r\nInclude the following placeholders in your `README.md` where you want the activity log to appear:\r\n\r\n```markdown\r\n\u003c!--START_SECTION:activity--\u003e\r\n\u003c!--END_SECTION:activity--\u003e\r\n```\r\n\r\nFor a reference example, you can view this [sample `README.md`](https://github.com/TheDanniCraft/activity-log/blob/master/README.md?plain=1#L20-L31).\r\n\r\n### 2. Create a Personal Access Token\r\n\r\n\u003cdetails open\u003e\r\n  \u003csummary\u003e\u003cstrong\u003eQuick Setup\u003c/strong\u003e \u003ci\u003e(Recommended)\u003c/i\u003e\u003c/summary\u003e\r\n\r\n  1. To create a personal access token with the necessary permissions, click this [link to create a new token](https://github.com/settings/tokens/new?description=Github%20Activity%20Log%20(TheDanniCraft/activity-log)\u0026scopes=repo). This link pre-fills the token description and scopes for your convenience.\r\n  2. On the token creation page, review the pre-filled data and set the expiration date to \"Never\".\r\n  3. Click \"Generate token\" and copy the token (be sure to save it as you won’t be able to see it again).\r\n\r\n\u003c/details\u003e\r\n\r\n\u003cdetails\u003e\r\n  \u003csummary\u003e\u003cstrong\u003eManual Setup\u003c/strong\u003e\u003c/summary\u003e\r\n\r\n  1. Go to your GitHub [Personal Access Tokens settings](https://github.com/settings/tokens).\r\n  2. Click on \"Generate new token\".\r\n  3. Provide a descriptive name for the token, such as `Github Activity Log (TheDanniCraft/activity-log)`.\r\n  4. Select the `repo` scope (recommended if you want private repo activity to show up).\r\n  5. Set the expiration date to \"Never\".\r\n  6. Click \"Generate token\" and copy the token (be sure to save it as you won’t be able to see it again).\r\n\r\n\u003c/details\u003e\r\n\r\n### 3. Add the Token as a Repository Secret\r\n\r\n1. Navigate to your GitHub repository.\r\n2. Go to \"Settings\" \u003e \"Secrets and variables\" \u003e \"Actions\".\r\n3. Click \"New repository secret\".\r\n4. Name the secret (e.g., `TOKEN`).\r\n5. Paste the personal access token into the value field.\r\n6. Click \"Add secret\".\r\n\r\n### 4. Create the Workflow File\r\n\r\nCreate a new file in your repository under `.github/workflows/`, for example, `activity-log.yml`. Add the following content to this file:\r\n\r\n```yml\r\n# .github/workflows/update-activity.yml:\r\n\r\nname: Update GitHub Activity\r\n\r\non:\r\n  schedule:\r\n    - cron: \"*/30 * * * *\" # Runs every 30 minutes\r\n  workflow_dispatch: # Allows manual triggering\r\n\r\njobs:\r\n  update-activity:\r\n    runs-on: ubuntu-latest\r\n    steps:\r\n      - uses: actions/checkout@v4\r\n      - name: Update GitHub Activity\r\n        uses: TheDanniCraft/activity-log@v1\r\n        with:\r\n          GITHUB_USERNAME: \"thedannicraft\"\r\n          GITHUB_TOKEN: ${{ secrets.TOKEN }} # Ensure this matches the secret name in repository settings\r\n```\r\n\r\nTake a look at all possible [Inputs](#inputs) for customization\r\n\r\nThe above job runs every half an hour, you can change it as you wish based on the [cron syntax](https://crontab.guru).\r\n\r\nPlease note that only those public events that belong to the following list show up:\r\n\r\n- `CreateEvent`\r\n- `PushEvent`\r\n- `IssuesEvent`\r\n  - `opened`\r\n  - `edited`\r\n  - `closed`\r\n  - `reopened`\r\n  - `assigned`\r\n  - `unassigned`\r\n  - `labeled`\r\n  - `unlabeled`\r\n- `PullRequestEvent`\r\n  - `opened`\r\n  - `edited`\r\n  - `closed`\r\n  - `merged`\r\n  - `reopened`\r\n  - `assigned`\r\n  - `unassigned`\r\n  - `review_requested`\r\n  - `review_request_removed`\r\n  - `labeled`\r\n  - `unlabeled`\r\n  - `synchronize`\r\n- `ReleaseEvent`\r\n- `ForkEvent`\r\n- `CommitCommentEvent`\r\n- `IssueCommentEvent`\r\n- `PullRequestReviewEvent`\r\n- `PullRequestReviewCommentEvent`\r\n- `RepositoryEvent`\r\n- `WatchEvent`\r\n- `StarEvent`\r\n- `PublicEvent`\r\n- `GollumEvent`\r\n\r\nYou can find an example [here](https://github.com/TheDanniCraft/activity-log/blob/master/.github/workflows/update-activity.yml).\r\n\r\n### Inputs\r\n\r\n| **Input**                       | **Description**                                                                                                                                                                 | **Required**     | **Default**                             | **Possible Options**                                                        |\r\n|---------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-----------------------------------------|-----------------------------------------------------------------------------|\r\n| `GITHUB_USERNAME`               | Your GitHub username.                                                                                                                                                           | ✅               | `-`                                     | A valid GitHub username                                                     |\r\n| `GITHUB_TOKEN`                  | Your GitHub token.                                                                                                                                                              | ✅               | `-`                                     | A valid GitHub access token (must belong to the specified GitHub username)  |\r\n| `EVENT_LIMIT`                   | The maximum number of events to display.                                                                                                                                        | ❌               | `10`                                    | Any positive integer (250 max.)                                             |\r\n| `OUTPUT_STYLE`                  | Specifies the format in which your output should be rendered. \u003cbr\u003e \u003cins\u003eMust be one of:\u003c/ins\u003e \u003cbr\u003e - `MARKDOWN`: Output in Markdown format \u003cbr\u003e - `HTML`: Output in HTML format | ❌               | `MARKDOWN`                              | `MARKDOWN` or `HTML`                                                        |\r\n| `IGNORE_EVENTS`                 | The events to ignore, specified as a JSON array.                                                                                                                                | ❌               | `[]`                                    | JSON array of event types (e.g., `[\"PushEvent\", \"PullRequestEvent\"]`)       |\r\n| `HIDE_DETAILS_ON_PRIVATE_REPOS` | Hide details (branch/tag name) on private repositories                                                                                                                          | ❌               | `false`                                 | `true` or `false`                                                           |\r\n| `README_PATH`                   | The path to your README file.                                                                                                                                                   | ❌               | `README.md`                             | Any valid file path                                                         |\r\n| `COMMIT_MESSAGE`                | Your commit message.                                                                                                                                                            | ❌               | `-`                                     | Any valid commit message                                                    |\r\n\r\n## 📜License\r\n\r\n[MIT](https://choosealicense.com/licenses/mit/)\r\n\r\n## ✍️Authors\r\n\r\n- [@thedannicraft](https://www.github.com/thedannicraft)\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheDanniCraft%2Factivity-log","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTheDanniCraft%2Factivity-log","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTheDanniCraft%2Factivity-log/lists"}