Skip to content

Commit

Permalink
Merge pull request #29 from sendbird/feature/add-changelog-filename
Browse files Browse the repository at this point in the history
feat: add changelog file input
  • Loading branch information
bang9 authored Jan 16, 2024
2 parents 812ab16 + d118648 commit 0dd65ea
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 4 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Make sure to set the required secret CircleCI API token in the repository settin
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 |
Expand All @@ -49,6 +49,7 @@ The action requires the following inputs:
| `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 |

## Commands

Expand Down
4 changes: 4 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ inputs:
required: false
description: 'Input actions run on testing environment'
default: 'false'
changelog_file:
required: false
description: 'Input changelog file name. (e.g. CHANGELOG_KTX_DRAFT.md) Default is CHANGELOG_DRAFT.md.'
default: 'CHANGELOG_DRAFT.md'
runs:
using: 'node16'
main: 'dist/index.js'
2 changes: 1 addition & 1 deletion dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/index.js.map

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion src/workflow.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,8 @@ async function buildCreateTicketParams(
basicParams.product,
release_version,
core.getInput('framework').toLowerCase()
)
),
changelog_file: core.getInput('changelog_file') || 'CHANGELOG_DRAFT.md'
}
}

Expand Down

0 comments on commit 0dd65ea

Please sign in to comment.