-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* Add workflow for changelog verification Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update format for changelog, add developer documentation Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update link reference to be relative to project Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Fix links for CHANGELOG versions Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> * Update contribution guide Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> Signed-off-by: Kunal Kotwani <kkotwani@amazon.com> (cherry picked from commit 5327767) Co-authored-by: Kunal Kotwani <kkotwani@amazon.com>
- Loading branch information
1 parent
cd855ad
commit a78d345
Showing
4 changed files
with
65 additions
and
3 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 |
---|---|---|
@@ -1,15 +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 javadoc added | ||
- [ ] Commits are signed per the DCO using --signoff | ||
- [ ] Commits are signed per the DCO using --signoff | ||
- [ ] Commit changes are listed out in CHANGELOG.md file (See: [Changelog](../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/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,22 @@ | ||
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.ref }} | ||
|
||
- uses: dangoslen/dependabot-changelog-helper@v1 | ||
|
||
- uses: stefanzweifel/git-auto-commit-action@v4 | ||
with: | ||
commit_message: "Update changelog" | ||
|
||
- uses: dangoslen/changelog-enforcer@v3 |
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 ([#4085](https://github.com/opensearch-project/OpenSearch/pull/4085)) | ||
|
||
### Changed | ||
|
||
### Deprecated | ||
|
||
### Removed | ||
|
||
### Fixed | ||
|
||
### Security | ||
|
||
|
||
[Unreleased]: https://github.com/opensearch-project/OpenSearch/compare/2.2.0...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