{"id":20942558,"url":"https://github.com/wow-actions/activity-report","last_synced_at":"2025-06-19T21:34:29.846Z","repository":{"id":40367750,"uuid":"351337840","full_name":"wow-actions/activity-report","owner":"wow-actions","description":"☢️ Generates a periodic automated summary of activities and happening on your Github repository","archived":false,"fork":false,"pushed_at":"2022-12-16T07:59:47.000Z","size":315,"stargazers_count":11,"open_issues_count":4,"forks_count":7,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-04T20:47:53.072Z","etag":null,"topics":["github-actions","report","summary"],"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/wow-actions.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}},"created_at":"2021-03-25T06:55:39.000Z","updated_at":"2025-04-14T17:52:41.000Z","dependencies_parsed_at":"2023-01-29T11:16:15.846Z","dependency_job_id":null,"html_url":"https://github.com/wow-actions/activity-report","commit_stats":{"total_commits":54,"total_committers":5,"mean_commits":10.8,"dds":0.09259259259259256,"last_synced_commit":"d88c66ee2cfd5852f73a11733ecd555965352433"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/wow-actions/activity-report","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Factivity-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Factivity-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Factivity-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Factivity-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wow-actions","download_url":"https://codeload.github.com/wow-actions/activity-report/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wow-actions%2Factivity-report/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260765618,"owners_count":23059311,"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","report","summary"],"created_at":"2024-11-18T23:28:09.587Z","updated_at":"2025-06-19T21:34:24.829Z","avatar_url":"https://github.com/wow-actions.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eActivity Report\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003eGenerates a periodic automated summary of activities and happening on your Github repository\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/wow-actions/activity-report/actions/workflows/test.yml\"\u003e\u003cimg alt=\"build\" src=\"https://img.shields.io/github/actions/workflow/status/wow-actions/activity-report/test.yml?branch=master\u0026logo=github\u0026style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT_License-green.svg?style=flat-square\" alt=\"MIT License\"\u003e\u003c/a\u003e\n\u003ca href=\"https://www.typescriptlang.org\"\u003e\u003cimg alt=\"Language\" src=\"https://img.shields.io/badge/language-TypeScript-blue.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/wow-actions/activity-report/pulls\"\u003e\u003cimg alt=\"PRs Welcome\" src=\"https://img.shields.io/badge/PRs-Welcome-brightgreen.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003ca href=\"https://lgtm.com/projects/g/wow-actions/activity-report/context:javascript\"\u003e\u003cimg alt=\"Language grade: JavaScript\" src=\"https://img.shields.io/lgtm/grade/javascript/g/wow-actions/activity-report.svg?logo=lgtm\u0026style=flat-square\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nOn running the action, it curates together the following data and publishes it as an issue:\n\n- Issues\n  - Open Issues\n  - Closed Issues\n  - Hot Issue\n  - Liked Issue\n- Pull requests\n  - Opened Pull Requests\n  - Updated Pull Requests\n  - Merged Pull Requests\n- Commits made in the master branch\n- Contributors\n- Stargazers\n- Releases\n\n## Usage\n\nCreate a `.github/workflows/weekly-report.yml` file in the repository you want to install this action:\n\n```yml\nname: Weekly Report\non:\n  schedule:\n    - cron: '0 6 * * 0' # At 06:00 on Sunday\njobs:\n  run:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: wow-actions/activity-report@v1\n        with:\n          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n```\n\n**It can only run on a `schedule` event.** This schedule uses a cron notation for fine-grained configuration. You can use the following cron notations. Also you can goto [https://crontab.guru](https://crontab.guru/) to design your cron notation which translating the cron schedule into human-readable format.\n\n- Daily - `0 8 * * *` At 08:00.\n- Weekly - `0 8 * * 0` At 08:00 on Sunday.\n- Monthly - `0 8 1 * *` At 08:00 on day-of-month 1.\n- Quarterly - `0 8 1 1/3 *` At 08:00 on day-of-month 1 in every 3rd month from January through December.\n- Half-Yearly - `0 8 1 1/6 *` At 08:00 on day-of-month 1 in every 6th month from January through December.\n- Yearly - `0 8 1 1 *` At 08:00 on day-of-month 1 in January.\n\nWe will auto detect your report type (`Daily`, `Weekly`, `Monthly`, `Quarterly`, `Half-Yearly` or `Yearly`) by the cron notation and replace the timing keywords in the issue(title and body). e.g. `\"Weekly Report (23 March, 2021 - 30 March, 2021)\"`. Other undetectable crons will fallback to use the inexact timing keywords. e.g. `\"Activity Report (25 March, 2021 - 30 March, 2021)\"`.\n\n## Inputs\n\nVarious inputs are defined to let you configure the action:\n\n\u003e Note: [Workflow command and parameter names are not case-sensitive](https://docs.github.com/en/free-pro-team@latest/actions/reference/workflow-commands-for-github-actions#about-workflow-commands).\n\n| Name | Description | Default |\n| --- | --- | --- |\n| `GITHUB_TOKEN` | The GitHub token for authentication | N/A |\n| `publish_issues` | Should publish issues or not | `true` |\n| `publish_top_liked_issues` | Should publish top liked issues with most positive reactions or not, or the count of top liked issues to publish | `3` |\n| `publish_top_hot_issues` | Should publish top hot issues with most comments or not, or the count of top hot issues to publish | `3` |\n| `publish_pull_requests` | Should publish pull requests or not | `true` |\n| `publish_contributors` | Should publish contributors or not | `true` |\n| `publish_stargazers` | Should publish stargazers or not | `true` |\n| `publish_commits` | Should publish commits or not | `true` |\n| `publish_releases` | Should publish releases or not | `true` |\n| `add_labels` | Comma separated labels to be add to the issue create by this action \u003cbr\u003e By default, the action will add a label in the form `\"{{ type }}-report\"`, such as `weekly-report`, to the issue |  |\n\n### Custom template the render the issue\n\nUsing these inputs of template to custom your report. The default templates can be found [here](/src/templates.ts). Follow the [`lodash.template`](https://www.npmjs.com/package/lodash.template) [documentation](https://lodash.com/docs#template).\n\n- template_title\n- template_header\n- template_footer\n- template_issues_title\n- template_issues_summary\n- template_issues_summary\n- template_issues_statistics\n- template_open_issues_title\n- template_open_issues_item\n- template_open_issues_item\n- template_closed_issues_title\n- template_closed_issues_item\n- template_liked_issues_title\n- template_liked_issues_item\n- template_liked_issues_item\n- template_liked_issues_reaction\n- template_hot_issues_title\n- template_hot_issues_item\n- template_pull_requests_title\n- template_pull_requests_summary\n- template_open_pull_requests_title\n- template_open_pull_requests_summary\n- template_open_pull_requests_item\n- template_updated_pull_requests_title\n- template_updated_pull_requests_summary\n- template_updated_pull_requests_item\n- template_merged_pull_requests_title\n- template_merged_pull_requests_summary\n- template_merged_pull_requests_item\n- template_commits_title\n- template_commits_summary\n- template_commits_item\n- template_contributors_title\n- template_contributors_summary\n- template_contributors_item\n- template_stargazers_title\n- template_stargazers_summary\n- template_stargazers_item\n- template_releases_title\n- template_releases_summary\n- template_releases_item\n\n## License\n\nThe scripts and documentation in this project are released under the [MIT License](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwow-actions%2Factivity-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwow-actions%2Factivity-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwow-actions%2Factivity-report/lists"}