{"id":15714355,"url":"https://github.com/roseline124/codereview-action","last_synced_at":"2025-05-12T13:42:28.198Z","repository":{"id":246157357,"uuid":"819664809","full_name":"roseline124/codereview-action","owner":"roseline124","description":"Automatically send Slack notifications when a pull request is opened, synchronized, or reopened. This action helps you keep your team informed about pull request activity without having to leave your Slack workspace.","archived":false,"fork":false,"pushed_at":"2024-07-09T01:38:52.000Z","size":5868,"stargazers_count":8,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-05T19:00:01.594Z","etag":null,"topics":["automation","chatops","ci-cd","devops","github-actions","notification","pull-request","slack","team-collaboration","workflow"],"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/roseline124.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-06-25T01:03:07.000Z","updated_at":"2025-02-23T09:26:57.000Z","dependencies_parsed_at":null,"dependency_job_id":"73618125-17f7-40fd-8faa-d4b716656d3b","html_url":"https://github.com/roseline124/codereview-action","commit_stats":null,"previous_names":["roseline124/codereview-action"],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roseline124%2Fcodereview-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roseline124%2Fcodereview-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roseline124%2Fcodereview-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/roseline124%2Fcodereview-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/roseline124","download_url":"https://codeload.github.com/roseline124/codereview-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253749430,"owners_count":21958120,"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":["automation","chatops","ci-cd","devops","github-actions","notification","pull-request","slack","team-collaboration","workflow"],"created_at":"2024-10-03T21:36:18.688Z","updated_at":"2025-05-12T13:42:28.177Z","avatar_url":"https://github.com/roseline124.png","language":"TypeScript","readme":"# PR Codereview Slack Notification Action\n\nIntegrate PR review activities into Slack with GitHub actions without a webhook server. All you need to do is add a github action workflow.\n\nenglish is default.\n\n![Preview Image](images/preview.png)\n\n## korean document\n\n- [한국어 문서 보기](KOREAN.md)\n\n## Features\n\n1. PR review notifications will be sent to the channel you set when you opened the PR.\n\n- \"@reviewer has sent a review request to @reviewer\"\n- The repo, PR title (PR LINK), PR description, and LABEL information will be sent along with it.\n\n2. if you add a reviewer, they will be mentioned in the PR opening message.\n\n3. If you label the PR open with emergency, it will be accompanied by an \"emergency\" message.\n\n- You can customize the label name.\n\n4. When you comment, the comment is replied to the PR open message as a thread.\n\n5. when you submit a PR review, you'll be commented on in the thread.\n\n- comment: Reply as a comment.\n- approve: Runs with LGTM message.\n- request change: Runs with the request change message.\n\n6. emoji when closing a PR\n\n- close: x emoji (customizable).\n- merge: white_check_mark emoji (customizable)\n\n7. set language you want: it supports `english`, `korean` now\n\n## How to use\n\n1. you need to create slack bot and add the bot to the channel.\n\nyou also need to add the permissions to slack bot like `channels:history`, `chat:write`, `chat:write.public`, `groups:history`, `reactions:write` in `OAuth \u0026 Permissions`\n\n2. create a pr-slack-notifiy.yml document inside `.github/workflows`\n\n```yml\nname: PR Slack Notification\n\non:\n  pull_request:\n    types: [opened, review_requested, closed]\n  issue_comment:\n    types: [created]\n  pull_request_review:\n    types: [submitted]\n\njobs:\n  notify:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n      - name: Notify Slack\n        uses: roseline124/codereview-action\n        with:\n          github_token: ${{ secrets.CODEREVIEWBOT_GITHUB_TOKEN }}\n          slack_token: ${{ secrets.SLACK_TOKEN }}\n          slack_channel: \u003cSLACK_CHANNEL_ID\u003e\n          slack_workspace: \u003cSLACK_WORKSPACE_NAME\u003e\n```\n\n3. create a `reviewers.yml` file in the root of your project. Please make sure to follow this format.\n\n```yml\nreviewers:\n  - githubName: roseline124\n    slackId: U07712R6TGS\n    name: hyunjisong\n  - githubName: roseline125\n    slackId: U07712R6TGS\n    name: leemonglyong\n  - githubName: roseline126\n    slackId: U07712R6TGS\n    name: hongkildong\n```\n\nYou can customize the file path with the `reviewers_file` input.\n\n```yml\nname: PR Slack Notification\n\non:\n  pull_request:\n    types: [opened, review_requested, closed]\n  issue_comment:\n    types: [created]\n  pull_request_review:\n    types: [submitted]\n\njobs:\n  notify:\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v2\n      - name: Notify Slack\n        uses: roseline124/codereview-action\n        with:\n          github_token: ${{ secrets.CODEREVIEWBOT_GITHUB_TOKEN }}\n          slack_token: ${{ secrets.SLACK_TOKEN }}\n          slack_channel: \u003cSLACK_CHANNEL_ID\u003e\n          slack_workspace: \u003cSLACK_WORKSPACE_NAME\u003e\n          reviewers_file: \u003cCUSTOM_FILE_PATH\u003e\n```\n\n4. about inputs\n\n| Input Name             | Description                                                                           | required | Default Value    |\n| ---------------------- | ------------------------------------------------------------------------------------- | -------- | ---------------- |\n| github_token           | add your github token                                                                 | true     | X                |\n| slack_token            | slack api \u003e OAuth \u0026 Permissions \u003e Bot User OAuth Token                                | true     | X                |\n| slack_channel          | you can get channel id from slack channel link                                        | true     | X                |\n| slack_workspace        | get this input from \u003cworkspace_name\u003e.slack.com                                        | true     | X                |\n| reviewers_file         | custom reviewers.yml file path                                                        | false    | reviewers.yml    |\n| slack_merge_emoji_name | merge emoji to attach to slack pr message                                             | false    | white_check_mark |\n| slack_close_emoji_name | close emoji to attach to slack pr message                                             | false    | x                |\n| emergency_label_name   | emergency label name. if this label exists, emergency message will be showed in slack | false    | emergency        |\n| language               | set language you (ex. `en`, `ko`)want                                                 | false    | en               |\n\n## test action\n\n1. test action\n\n- `act pull_request` (you need to install act)\n\n2. if you use colima,\n\n- `sudo ln -s /Users/{username}/.colima/default/docker.sock /var/run/docker.sock`\n\n3. set event like this\n\n- pr open event: `act pull_request --eventpath event-open.json`\n\n## release\n\n1. make changes\n\n- `pnpm build`\n- commit \u0026 push\n\n2. if you push to\n\n- `feature` branch: it release alpha tag (use alpha tag when testing)\n- `main` branch: it release version tag \u0026 bump up the version\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froseline124%2Fcodereview-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Froseline124%2Fcodereview-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Froseline124%2Fcodereview-action/lists"}