{"id":27657065,"url":"https://github.com/sendbird/release-automation-action","last_synced_at":"2025-04-24T06:53:54.617Z","repository":{"id":151705596,"uuid":"618134908","full_name":"sendbird/release-automation-action","owner":"sendbird","description":"Release automation comment bot","archived":false,"fork":false,"pushed_at":"2025-04-10T02:16:21.000Z","size":1364,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-24T06:53:44.196Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":false,"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/sendbird.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":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-23T20:31:58.000Z","updated_at":"2025-04-10T02:16:22.000Z","dependencies_parsed_at":"2024-08-01T04:28:35.571Z","dependency_job_id":"e2715500-ee4c-4d39-8e8d-1a249374913a","html_url":"https://github.com/sendbird/release-automation-action","commit_stats":null,"previous_names":[],"tags_count":21,"template":false,"template_full_name":"actions/typescript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Frelease-automation-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Frelease-automation-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Frelease-automation-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sendbird%2Frelease-automation-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sendbird","download_url":"https://codeload.github.com/sendbird/release-automation-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250580705,"owners_count":21453531,"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":"2025-04-24T06:53:54.014Z","updated_at":"2025-04-24T06:53:54.608Z","avatar_url":"https://github.com/sendbird.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# release-automation-action\n\nThis GitHub Action is designed to be used as a comment bot in a release automation process.\n\nWhen an PR comment is created, the action will check if the comment contains a specific command and then execute an action based on the command.\nIf the conditions are met, the script extracts a command from the comment and runs it.\n\n## Usage\n\nTo use this action, create a new workflow in your GitHub repository that listens for issue_comment events, but only for Pull Request comments.\n\nThen, add the following step to the workflow:\n\n```yaml\nname: PR Comment Bot\non:\n  issue_comment:\n    types: [created]\njobs:\n  pr-comment:\n    if: ${{ github.event.issue.pull_request }}\n    runs-on: ubuntu-latest\n    steps:\n      - uses: actions/checkout@v3\n      - uses: sendbird/release-automation-action@latest\n        with:\n          gh_token: ${{ secrets.GITHUB_TOKEN }}\n          circleci_token: ${{ secrets.CIRCLECI_TOKEN }}\n          product: 'uikit'\n          platform: 'rn'\n          product_jira_project_key: 'UIKIT'\n          product_jira_version_prefix: 'rn_uikit'\n```\n\nReplace version with the version of the action you want to use.\n\nMake sure to set the required secret CircleCI API token in the repository settings.\n\n## Inputs\n\nThe action requires the following inputs:\n\n| name                          | description                                                                                                                                                                | required |\n| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |\n| `gh_token`                    | The GitHub access token used to authenticate with the Octokit instance.                                                                                                    | Yes      |\n| `circleci_token`              | The CircleCI API token used to trigger the build and deploy workflow.                                                                                                      | Yes      |\n| `product`                     | The name of the product's SDK, such as `chat`, `calls`, `uikit`, `live`, or `live_uikit`.                                                                                  | Yes      |\n| `platform`                    | The platform for the product's SDK, such as `ios`, `android`, `js`, `rn`, or `flutter`.                                                                                    | Yes      |\n| `product_jira_project_key`    | The project key for the product's Jira project, such as `CORE`, `UIKIT`, `CALLS`, or `PLATFORMX`.                                                                          | Yes      |\n| `product_jira_version_prefix` | (Optional) The custom release version prefix for the product's Jira project, such as `ios_core`, `rn_uikit`, or `js_uikit`. (default: {product}-{platform}[-{framework}]?) | No       |\n| `framework`                   | (Optional) The framework for the product's SDK, such as `react`.                                                                                                           | No       |\n| `test`                        | (Optional) Ticket creation and slack alerts are executed in the test environment (release board, slack channel). (default: false)                                          | No       |\n| `changelog_file`              | (Optional) Changelog file name (e.g. CHANGELOG_KTX_DRAFT.md). (default: CHANGELOG_DRAFT.md)                                                                                | No       |\n| `ci`                          | (Optional) The CI provider to use for the build and deploy workflow. Supported values: `circleci`, `github`. (default: circleci)                                           | No       |\n\n## Commands\n\nYou can use the following commands in the PR comment:\n\n| command              | description                           |\n| -------------------- | ------------------------------------- |\n| `/bot create ticket` | Creates a new release ticket in Jira. |\n\n### Command parameters\n\n- You can pass `--test` parameter to command: `/bot create ticket --test`\n- You can pass `--ci` parameter to command: `/bot create ticket --ci=github`\n\n## Slack notifications\n\nIt mentions the `@{{product}}-approver` Slack group to notify ticket creation in the channel.\nIf it's a new product, you need to add a Slack group with the corresponding name so that the appropriate people can be mentioned.\n\nThe Slack message is sent in the following format:\n`@{{product}}-approver 🔖{{product_jira_version_prefix}} {{version}} release ticket has been created!`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Frelease-automation-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsendbird%2Frelease-automation-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsendbird%2Frelease-automation-action/lists"}