https://github.com/sendbird/release-automation-action
Release automation comment bot
https://github.com/sendbird/release-automation-action
Last synced: about 1 year ago
JSON representation
Release automation comment bot
- Host: GitHub
- URL: https://github.com/sendbird/release-automation-action
- Owner: sendbird
- License: mit
- Created: 2023-03-23T20:31:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-10T02:16:21.000Z (about 1 year ago)
- Last Synced: 2025-04-24T06:53:44.196Z (about 1 year ago)
- Language: TypeScript
- Size: 1.3 MB
- Stars: 2
- Watchers: 8
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# release-automation-action
This GitHub Action is designed to be used as a comment bot in a release automation process.
When 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.
If the conditions are met, the script extracts a command from the comment and runs it.
## Usage
To use this action, create a new workflow in your GitHub repository that listens for issue_comment events, but only for Pull Request comments.
Then, add the following step to the workflow:
```yaml
name: PR Comment Bot
on:
issue_comment:
types: [created]
jobs:
pr-comment:
if: ${{ github.event.issue.pull_request }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: sendbird/release-automation-action@latest
with:
gh_token: ${{ secrets.GITHUB_TOKEN }}
circleci_token: ${{ secrets.CIRCLECI_TOKEN }}
product: 'uikit'
platform: 'rn'
product_jira_project_key: 'UIKIT'
product_jira_version_prefix: 'rn_uikit'
```
Replace version with the version of the action you want to use.
Make sure to set the required secret CircleCI API token in the repository settings.
## Inputs
The action requires the following inputs:
| name | description | required |
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| `gh_token` | The GitHub access token used to authenticate with the Octokit instance. | Yes |
| `circleci_token` | The CircleCI API token used to trigger the build and deploy workflow. | Yes |
| `product` | The name of the product's SDK, such as `chat`, `calls`, `uikit`, `live`, or `live_uikit`. | Yes |
| `platform` | The platform for the product's SDK, such as `ios`, `android`, `js`, `rn`, or `flutter`. | Yes |
| `product_jira_project_key` | The project key for the product's Jira project, such as `CORE`, `UIKIT`, `CALLS`, or `PLATFORMX`. | Yes |
| `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 |
| `framework` | (Optional) The framework for the product's SDK, such as `react`. | No |
| `test` | (Optional) Ticket creation and slack alerts are executed in the test environment (release board, slack channel). (default: false) | No |
| `changelog_file` | (Optional) Changelog file name (e.g. CHANGELOG_KTX_DRAFT.md). (default: CHANGELOG_DRAFT.md) | No |
| `ci` | (Optional) The CI provider to use for the build and deploy workflow. Supported values: `circleci`, `github`. (default: circleci) | No |
## Commands
You can use the following commands in the PR comment:
| command | description |
| -------------------- | ------------------------------------- |
| `/bot create ticket` | Creates a new release ticket in Jira. |
### Command parameters
- You can pass `--test` parameter to command: `/bot create ticket --test`
- You can pass `--ci` parameter to command: `/bot create ticket --ci=github`
## Slack notifications
It mentions the `@{{product}}-approver` Slack group to notify ticket creation in the channel.
If it's a new product, you need to add a Slack group with the corresponding name so that the appropriate people can be mentioned.
The Slack message is sent in the following format:
`@{{product}}-approver 🔖{{product_jira_version_prefix}} {{version}} release ticket has been created!`