{"id":34151923,"url":"https://github.com/buildkite-plugins/pr-commenter-buildkite-plugin","last_synced_at":"2025-12-15T05:47:15.934Z","repository":{"id":265675727,"uuid":"823555756","full_name":"buildkite-plugins/pr-commenter-buildkite-plugin","owner":"buildkite-plugins","description":"🔌 A Buildkite plugin for posting comments from a step to a PR.","archived":false,"fork":false,"pushed_at":"2025-12-12T15:19:51.000Z","size":62,"stargazers_count":4,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-12-14T06:37:58.213Z","etag":null,"topics":["buildkite","buildkite-plugin","go"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/buildkite-plugins.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-03T08:55:21.000Z","updated_at":"2025-12-12T15:15:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"3fe1f6a7-f8ef-48e6-8258-f98161ecca39","html_url":"https://github.com/buildkite-plugins/pr-commenter-buildkite-plugin","commit_stats":null,"previous_names":["buildkite-plugins/pr-commenter-buildkite-plugin","mcncl/pr-commenter-buildkite-plugin"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/buildkite-plugins/pr-commenter-buildkite-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildkite-plugins%2Fpr-commenter-buildkite-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildkite-plugins%2Fpr-commenter-buildkite-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildkite-plugins%2Fpr-commenter-buildkite-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildkite-plugins%2Fpr-commenter-buildkite-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/buildkite-plugins","download_url":"https://codeload.github.com/buildkite-plugins/pr-commenter-buildkite-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/buildkite-plugins%2Fpr-commenter-buildkite-plugin/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27744797,"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-12-15T02:00:09.782Z","response_time":96,"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":["buildkite","buildkite-plugin","go"],"created_at":"2025-12-15T05:47:15.482Z","updated_at":"2025-12-15T05:47:15.922Z","avatar_url":"https://github.com/buildkite-plugins.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PR Commenter Plugin [![Build status](https://badge.buildkite.com/70e1d545dabb9e07d0c52537f5ae31e4d1f225e130e33ebcae.svg?branch=main)](https://buildkite.com/buildkite/plugins-pr-commenter)\nA Buildkite plugin written in Go that enables commenting on pull requests that builds are triggered from.\n\nThe plugin uses the `/issues` endpoint as that doesn't require a commit SHA or file name in order to post the comment; this comment will post to the `conversation` tab and won't be associated with any file changes.\n\nThe plugin has been tested and built using **go 1.20.3**, so it is not guaranteed to work on versions **\u003c1.20.3**.\n\nThe plugin binary will get built in the step and output as a `pre-exit` hook. This ensures that it runs as the last command on the step and is able to get the *exit code* of the step that it runs on (necessary for the default message).\n\nThe use of this plugin requires that clusters are being used and that the secret is available on that cluster, else the plugin will error.\n\n## 👩‍💻 Usage\n\nAdd the following to your `pipeline.yml`:\n\n```yaml\n    steps:\n        command: echo \"~~~ :github: Add approval comment Pull Request\"\n        plugins:\n            - pr-commenter#v0.1.0:\n                message: \"LGTM!\"\n                secret-name: GITHUB_TOKEN\n```\n\n## 📒 Options\n\n### `secret-name` (optional, string)\nThe environment variable that contains the value of the GitHub API token. If not set, the plugin will try to get the URL from the default configuration.\n\nDefault: `GITHUB_TOKEN`\n\n### `message` (optional, string)\nThe message which should be posted to the PR. This can be a dynamic value, such as `$BUILDKITE_COMMAND`\n\nDefault: `[${BUILDKITE_BUILD_URL}#${BUILDKITE_JOB_ID}](${BUILDKITE_BUILD_URL}#${BUILDKITE_JOB_ID}) exited with code ${BUILDKITE_COMMAND_EXIT_STATUS}`\n\n## Compatibility\n\n| Elastic Stack | Agent Stack K8s | Hosted (Mac) | Hosted (Linux) | Notes |\n| :-----------: | :-------------: | :----: | :----: |:---- |\n| ✅ | ⚠️ | ✅ | ✅ | K8s: The `go` binary will need to be available on the agents |\n\n- ✅ Fully supported (all combinations of attributes have been tested to pass)\n- ⚠️ Partially supported (some combinations cause errors/issues)\n\n## 🛠️ Development\n### Running the tests\nThe tests are written using Go's built-in testing package.\n\nTests can be run using:\n\n```shell\ngo test -v ./...\n```\n\n\n## 💪 Contributing\n\nWe welcome all contributions to improve this plugin! To contribute, please follow these guidelines:\n\n- Fork the repository\n- Make your changes and ensure that the tests pass.\n- Write clear and concise commit messages.\n- Submit a pull request.\n\nBy contributing, you agree to license your contributions under the LICENSE file of this repository.\n\n## License\nMIT (see [LICENSE](LICENSE.MD))\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuildkite-plugins%2Fpr-commenter-buildkite-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbuildkite-plugins%2Fpr-commenter-buildkite-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbuildkite-plugins%2Fpr-commenter-buildkite-plugin/lists"}