-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add changelog and changelog verifier
Signed-off-by: Harsha Vamsi Kalluri <harshavamsi096@gmail.com>
- Loading branch information
1 parent
25a1a6f
commit 0bb9276
Showing
4 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
### 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 | ||
- [ ] Commit changes are listed out in CHANGELOG.md file (See: [Changelog](https://github.com/opensearch-project/opensearch-go/blob/main/CONTRIBUTING.md#changelog)) | ||
|
||
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 Developer Certificate of Origin and signing off your commits, please check [here](https://github.com/opensearch-project/opensearch-go/blob/main/CONTRIBUTING.md#developer-certificate-of-origin). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: "Changelog Verifier" | ||
on: | ||
pull_request: | ||
types: [opened, edited, review_requested, synchronize, reopened, ready_for_review, labeled, unlabeled] | ||
|
||
jobs: | ||
# Enforces the update of a changelog file on every pull request | ||
verify-changelog: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
ref: ${{ github.event.pull_request.head.sha }} | ||
|
||
- uses: dangoslen/changelog-enforcer@v3 | ||
with: | ||
skipLabels: "autocut" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# CHANGELOG | ||
Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) | ||
|
||
## [Unreleased] | ||
### Added | ||
- Github workflow for changelog verification ([#102](https://github.com/opensearch-project/opensearch-go/pull/102)) | ||
|
||
### Changed | ||
|
||
### Deprecated | ||
|
||
### Removed | ||
|
||
### Fixed | ||
|
||
### Security | ||
|
||
|
||
[Unreleased]: https://github.com/opensearch-project/opensearch-go/compare/2.1...HEAD |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters