{"id":17237706,"url":"https://github.com/tizmagik/customizable-comments","last_synced_at":"2025-09-11T21:06:54.348Z","repository":{"id":33598223,"uuid":"159706824","full_name":"tizmagik/customizable-comments","owner":"tizmagik","description":"A GitHub App built with Probot that auto-replies with customizable comments based on template vars","archived":false,"fork":false,"pushed_at":"2023-01-09T17:09:51.000Z","size":1086,"stargazers_count":3,"open_issues_count":21,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-03T02:37:00.289Z","etag":null,"topics":["hacktoberfest","probot","probot-app"],"latest_commit_sha":null,"homepage":"https://github.com/apps/probot-cc","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tizmagik.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":null,"support":null}},"created_at":"2018-11-29T18:00:18.000Z","updated_at":"2023-10-13T16:39:43.000Z","dependencies_parsed_at":"2023-01-15T01:35:22.313Z","dependency_job_id":null,"html_url":"https://github.com/tizmagik/customizable-comments","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tizmagik%2Fcustomizable-comments","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tizmagik%2Fcustomizable-comments/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tizmagik%2Fcustomizable-comments/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tizmagik%2Fcustomizable-comments/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tizmagik","download_url":"https://codeload.github.com/tizmagik/customizable-comments/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244776860,"owners_count":20508602,"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":["hacktoberfest","probot","probot-app"],"created_at":"2024-10-15T05:43:31.614Z","updated_at":"2025-03-21T10:25:17.881Z","avatar_url":"https://github.com/tizmagik.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# customizable-comments (probot-cc)\n\nA GitHub App built with [Probot](https://github.com/probot/probot) that auto-replies with customizable comments based on template vars\n\n\u003cimg src=\"./public/probot-cc-sample.png\" /\u003e\n\n## Usage\n\n1. Install the [Customizable Comments (probot-cc) GitHub App](https://github.com/apps/probot-cc) into the repo(s) you wish to use it on.\n1. Add a `.github/customizable-comments.yml` configuration file to each repo.\n\n## Configuration options\n\n_📒 Currently, this Probot App only supports `pull_request.opened` events. I would be happy to add more, just submit a PR or Issue with what you'd find useful._\n\n### Built-in template vars\n\n| name               | value                                                                                                            | used when      |\n| ------------------ | ---------------------------------------------------------------------------------------------------------------- | -------------- |\n| \\$BRANCH           | The branch name of the PR                                                                                        | `pull_request` |\n| \\$BRANCH_SANITIZED | The branch name of the PR but sanitized as safe for URL prefixes (lowercased, `.` and `/` are replaced with `-`) | `pull_request` |\n\n### Custom template vars\n\nYou can configure your own variable replacements using the `vars:` block in the yml file. See the example below:\n\n## Example\n\n```yaml\nvars:\n  - name: $MY_CUSTOM\n    value: my-value\n\npull_request:\n  opened:\n    template: |\n      Here's a helpful URL based on the branch name: https://$BRANCH.something.example.com\n      And here's my custom value: $MY_CUSTOM\n```\n\nThe above will auto-reply with a comment like so:\n\n```\nHere's a helpful URL based on the branch name: https://the-branch.something.example.com\nAnd here's my custom value: my-custom\n```\n\n## Local Development\n\n```sh\n# Install dependencies\nnpm install\n\n# Run the bot\nnpm run dev\n```\n\n## Rather host yourself?\n\nFeel free to host this app yourself \"on-prem\" if you like. It should support Lambda or Google Cloud Functions with minimal fuss:\n\n### Deploying as GCF ☁️\n\n\u003e Note: This is currently disabled in the code, since I'm deploying to Vercel for public use, but can be re-enabled easily if you're self-hosting.\n\nThis Probot app supports deploying as a Google Cloud Function out of the box:\n\n```\ngcloud beta functions deploy gcf-name --env-vars-file .env.yaml --entry-point probot --runtime nodejs8 --trigger-http\n```\n\nWhere:\n\n- `gcf-name`: desired name of the GCF\n- `.env.yaml`: see [.env.yaml.example](./.env.yaml.example)\n\nSee [Probot Deployment docs](https://probot.github.io/docs/deployment/) for other deployment options.\n\n## Contributing\n\nIf you have suggestions for how customizable-comments could be improved, or want to report a bug, open an issue! We'd love all and any contributions.\n\nFor more, check out the [Contributing Guide](CONTRIBUTING.md).\n\n## License\n\n[ISC](LICENSE) © 2018 Jeremy Gayed \u003chttps://twitter.com/tizmagik\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftizmagik%2Fcustomizable-comments","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftizmagik%2Fcustomizable-comments","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftizmagik%2Fcustomizable-comments/lists"}