diff --git a/.github/workflows/changelog-ci-config.json b/.github/workflows/changelog-ci-config.json new file mode 100644 index 000000000..75565acc8 --- /dev/null +++ b/.github/workflows/changelog-ci-config.json @@ -0,0 +1,25 @@ +{ + "changelog_type": "commit_message", + "header_prefix": "Version:", + "commit_changelog": true, + "comment_changelog": true, + "pull_request_title_regex": "^Release", + "group_config": [ + { + "title": "Bug Fixes", + "labels": ["bug", "bugfix"] + }, + { + "title": "Code Improvements", + "labels": ["improvements", "enhancement"] + }, + { + "title": "New Features", + "labels": ["feature"] + }, + { + "title": "Documentation Updates", + "labels": ["docs", "documentation", "doc"] + } + ] +} diff --git a/.github/workflows/changelog-generator.yml b/.github/workflows/changelog-generator.yml index 510fbf48c..63d453fa6 100644 --- a/.github/workflows/changelog-generator.yml +++ b/.github/workflows/changelog-generator.yml @@ -1,20 +1,24 @@ -- name: Run Changelog CI - uses: saadmk11/changelog-ci@v0.8.0 - with: - # Optional, you can provide any name for your changelog file, - # defaults to `CHANGELOG.md` if not provided. - changelog_filename: MY_CHANGELOG.md - # Optional, only required when you want more customization - # e.g: group your changelog by labels with custom titles, - # different version prefix, pull request title and version number regex etc. - # config file can be in JSON or YAML format. - config_file: changelog-ci-config.json - # Optional, This will be used to configure git - # defaults to `github-actions[bot]` if not provided. - committer_username: 'test' - committer_email: 'test@test.com' - env: - # optional, only required for `private` repositories - # and required if the changelog comment - # option is turned on through the config file - GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} +name: Changelog CI + +# Controls when the action will run. Triggers the workflow on a pull request +on: + pull_request: + types: [ opened, reopened ] + +jobs: + build: + runs-on: ubuntu-latest + + steps: + # Checks-out your repository + - uses: actions/checkout@v2 + + - name: Run Changelog CI + uses: saadmk11/changelog-ci@v0.8.0 + with: + changelog_filename: CHANGELOG.md + config_file: changelog-ci-config.json + # Add this if you are using it on a private repository + # Or if you have turned on commenting through the config file. + env: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1 @@ +