From efe99e2e36e319c88709ac356a32cbde9083d00d Mon Sep 17 00:00:00 2001 From: Harsha Vamsi Kalluri Date: Thu, 20 Oct 2022 16:22:20 +0000 Subject: [PATCH] Adding dependabot changelog verifier Signed-off-by: Harsha Vamsi Kalluri --- .github/dependabot.yml | 3 +++ .github/pull_request_template.md | 16 ------------- .github/workflows/dependabot_pr.yml | 37 +++++++++++++++++++++++++++++ CHANGELOG.md | 1 + CONTRIBUTING.md | 6 ++--- 5 files changed, 44 insertions(+), 19 deletions(-) delete mode 100644 .github/pull_request_template.md create mode 100644 .github/workflows/dependabot_pr.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml index e78a40e..91c11a3 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -4,4 +4,7 @@ updates: package-ecosystem: pip schedule: interval: weekly + labels: + - "dependabot" + - "dependencies" version: 2 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md deleted file mode 100644 index f7eecdd..0000000 --- a/.github/pull_request_template.md +++ /dev/null @@ -1,16 +0,0 @@ -### Description -[Describe what this change achieves] - -### Issues Resolved -[List any issues this PR will resolve] - -### Check List -- [ ] New functionality includes testing. - - [ ] All tests pass. -- [ ] New functionality has been documented. - - [ ] New functionality has comments added. -- [ ] Commits are signed per the DCO using --signoff. -- [ ] [CHANGELOG](https://github.com/opensearch-project/opensearch-dsl-py/blob/main/CONTRIBUTING.md#changelog) has been updated. - -By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. -For more information on following the Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/opensearch-dsl-py/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). \ No newline at end of file diff --git a/.github/workflows/dependabot_pr.yml b/.github/workflows/dependabot_pr.yml new file mode 100644 index 0000000..f13889c --- /dev/null +++ b/.github/workflows/dependabot_pr.yml @@ -0,0 +1,37 @@ +name: Dependabot PR actions +on: pull_request + +jobs: + dependabot: + runs-on: ubuntu-latest + permissions: + pull-requests: write + contents: write + if: ${{ github.actor == 'dependabot[bot]' }} + steps: + - name: GitHub App token + id: github_app_token + uses: tibdex/github-app-token@v1.5.0 + with: + app_id: ${{ secrets.APP_ID }} + private_key: ${{ secrets.APP_PRIVATE_KEY }} + installation_id: 22958780 + + - name: Check out code + uses: actions/checkout@v2 + with: + token: ${{ steps.github_app_token.outputs.token }} + + - name: Update the changelog + uses: dangoslen/dependabot-changelog-helper@v1 + with: + version: 'Unreleased' + + - name: Commit the changes + uses: stefanzweifel/git-auto-commit-action@v4 + with: + commit_message: "Update changelog" + branch: ${{ github.head_ref }} + commit_user_name: dependabot[bot] + commit_user_email: support@github.com + commit_options: '--signoff' \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index d4992e4..13a94c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Github workflow for changelog verification ([#81](https://github.com/opensearch-project/opensearch-dsl-py/pull/81)) ### Changed +- Updating maintainers and workflows for dependabot changelog ([#82](https://github.com/opensearch-project/opensearch-dsl-py/pull/82)) ### Deprecated diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e4a2007..889da53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ - [Contributing Code](#contributing-code) - [Developer Certificate of Origin](#developer-certificate-of-origin) - [Changelog](#changelog) - - [Adding changes](#adding-changes) + - [Adding Changes](#adding-changes) - [Review Process](#review-process) ## Contributing to OpenSearch @@ -89,12 +89,12 @@ You may type this line on your own when writing your commit messages. However, i ## Changelog -OpenSearch-Dsl-Py maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. +OpenSearch-dsl-py maintains a version specific changelog by enforcing a change to the ongoing [CHANGELOG](CHANGELOG.md) file adhering to the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format. The changes are curated by version, with the changes to the main branch added chronologically to the `Unreleased` version. Each version has corresponding sections which list out the category of the change - `Added`, `Changed`, `Deprecated`, `Removed`, `Fixed`, `Security`. -### Adding changes +### Adding Changes As a contributor, you must ensure that every pull request has its changes listed out within the corresponding version and appropriate section of the [CHANGELOG](CHANGELOG.md) file.