{"id":19404284,"url":"https://github.com/hasithaishere/route-commenter-action","last_synced_at":"2025-02-25T00:32:14.672Z","repository":{"id":251031503,"uuid":"836165813","full_name":"hasithaishere/route-commenter-action","owner":"hasithaishere","description":"A GitHub Action to add comments to changed routes in PRs.","archived":false,"fork":false,"pushed_at":"2024-08-06T08:00:12.000Z","size":442,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-07T12:47:33.211Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/hasithaishere.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-07-31T09:31:41.000Z","updated_at":"2024-08-06T08:00:04.000Z","dependencies_parsed_at":"2024-08-05T06:29:20.664Z","dependency_job_id":"bc17bfec-7807-4a30-90d3-5b571d5c12b5","html_url":"https://github.com/hasithaishere/route-commenter-action","commit_stats":null,"previous_names":["hasithaishere/route-commenter-action"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Froute-commenter-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Froute-commenter-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Froute-commenter-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hasithaishere%2Froute-commenter-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hasithaishere","download_url":"https://codeload.github.com/hasithaishere/route-commenter-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240581423,"owners_count":19824139,"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-10T11:33:52.961Z","updated_at":"2025-02-25T00:32:14.642Z","avatar_url":"https://github.com/hasithaishere.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# Route Commenter Action\n\nThis GitHub Action detects changes in route files within a PR and adds comments to the start of modified route blocks.\n\n## Usage\n\nCreate a workflow file in your repository (e.g., `.github/workflows/route-commenter.yml`):\n\n```yaml\nname: Route Commenter\n\non:\n  pull_request:\n    types: [opened, synchronize, reopened]\n    branches:\n      - 'master'\n\npermissions:\n  contents: read\n  pull-requests: write\n\njobs:\n  comment-routes:\n    runs-on: ubuntu-latest\n\n    steps:\n    - name: Checkout monorepo\n      uses: actions/checkout@v2\n      with:\n        fetch-depth: 0\n\n    - name: Route Commenter Action\n      uses: hasithaishere/route-commenter-action@main\n      env:\n        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n        INPUT_COMMENT_CONTENT_FILE: '.github/config/route-comment-content.md' # Optional: has hardcoded default content\n        INPUT_TAG_NAME: 'change-route' # Optional: default is 'change-route'\n```\n\nCreate a route comment content file in your repository (e.g., `.github/config/route-comment-content.md`):\n\n```markdown\n\u003c!-- ROUTE_COMMENT_START --\u003e\n# Route change detected:\n- [ ] Have you checked ACL middlewares configs?\n- [ ] Have you checked the route is not breaking any existing functionality?\n- [ ] Have you checked the route is not breaking any existing tests?\n- [ ] Have you documented the route changes?\n\u003c!-- ROUTE_COMMENT_END --\u003e\n```\nThis content file will be optional and the default content will be used if not provided.\n\n## For Maintainers\n\nAs general, this Github action also use ncc to package the code in to single js file. So in the development please globally install ncc first.\n\n```sh\nnpm i -g @vercel/ncc --save\n```\n\nAfter your development, please execute following command for building the package file, then push the code to GitHub.\n\n```sh\nnpm run build\n```\n\n## Developers\n\n- [Hasitha Gamage](hasitha@rocketbots.io)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasithaishere%2Froute-commenter-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhasithaishere%2Froute-commenter-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhasithaishere%2Froute-commenter-action/lists"}