{"id":18282948,"url":"https://github.com/zentered/reading-time-action","last_synced_at":"2025-04-09T05:41:21.027Z","repository":{"id":44813907,"uuid":"380189785","full_name":"zentered/reading-time-action","owner":"zentered","description":"GitHub Action to calculate the reading time of Markdown files and write the results to a manifest.json","archived":false,"fork":false,"pushed_at":"2022-01-22T21:46:28.000Z","size":404,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T23:05:58.529Z","etag":null,"topics":[],"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/zentered.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-25T09:31:20.000Z","updated_at":"2021-06-25T14:27:25.000Z","dependencies_parsed_at":"2022-08-30T23:11:59.610Z","dependency_job_id":null,"html_url":"https://github.com/zentered/reading-time-action","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Freading-time-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Freading-time-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Freading-time-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zentered%2Freading-time-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zentered","download_url":"https://codeload.github.com/zentered/reading-time-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247987096,"owners_count":21028891,"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":[],"created_at":"2024-11-05T13:06:47.777Z","updated_at":"2025-04-09T05:41:20.997Z","avatar_url":"https://github.com/zentered.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"docs/rttm.png\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/zentered/reading-time-action/actions/workflows/test.yml\"\u003e\u003cimg alt=\"Unit Test status\" src=\"https://github.com/zentered/reading-time-action/actions/workflows/test.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/zentered/reading-time-action/actions/workflows/publish.yml\"\u003e\u003cimg alt=\"Unit Test status\" src=\"https://github.com/zentered/reading-time-action/actions/workflows/publish.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://semantic-release.gitbook.io/semantic-release/\"\u003e\u003cimg alt=\"Semantic Release bagde\" src=\"https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://zentered.co\"\u003e\u003cimg alt=\"Semantic Release bagde\" src=\"https://img.shields.io/badge/\u003e-Zentered-lightgrey?style=flat\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Reading Time to Manifest Action\n\nGitHub Action to calculate reading time of Markdown files in the specified folder and add results to a manifest.json\n\n## Usage\n\n```yaml\n- uses: zentered/reading-time-action\n  with:\n    path: docs\n```\n\n## Inputs\n\n| Name   | Requirement | Default | Description                                            |\n| ------ | ----------- | ------- | ------------------------------------------------------ |\n| `path` | optional    | `docs`  | Path where the markdown files and manifest are located |\n\n## Outputs\n\n```json\n{\n  \"text\": \"1 min\",\n  \"minutes\": 0.475,\n  \"time\": 28500,\n  \"words\": 95\n}\n```\n\n## Complete Workflow with Commit \u0026 Push\n\nThis action does not commit/push to your repo. You can use the [github-push-action](https://github.com/ad-m/github-push-action). Here's a complete example:\n\n```yaml\nname: Reading Time\n\n on:\n   push:\n     branches:\n       - '**'\n       - '!main'\n     paths:\n       - 'docs/**'\n\n jobs:\n   reading-time:\n     runs-on: ubuntu-latest\n     name: calculate reading time\n     steps:\n       - uses: actions/checkout@v2\n       - name: Сalculate reading time\n         uses: zentered/reading-time-action@v1.0.0\n       - name: Commit Manifest\n         run: |\n           git config --local user.email \"41898282+github-actions[bot]@users.noreply.github.com\"\n           git config --local user.name \"github-actions[bot]\"\n           git commit docs/manifest.json -m \"chore: calculate reading time\"\n       - name: Push changes\n         uses: ad-m/github-push-action@v0.6.0\n         with:\n           github_token: ${{ secrets.GITHUB_TOKEN }}\n           branch: ${{ github.ref }}\n```\n\n## Contributing\n\nSee [CONTRIBUTING](CONTRIBUTING.md).\n\n## License\n\nSee [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzentered%2Freading-time-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzentered%2Freading-time-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzentered%2Freading-time-action/lists"}