diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 84a5aaaacedf..c5d1c4e35f36 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -5,10 +5,11 @@ [List any issues this PR will resolve] ### Check List +- [ ] All tests pass + - [ ] `yarn test:jest` + - [ ] `yarn test:jest_integration` + - [ ] `yarn test:ftr` - [ ] New functionality includes testing. - - [ ] All tests pass - - [ ] `yarn test:jest` - - [ ] `yarn test:jest_integration` - - [ ] `yarn test:ftr` - [ ] New functionality has been documented. +- [ ] Update [CHANGELOG.md](./../CHANGELOG.md) - [ ] Commits are signed per the DCO using --signoff \ No newline at end of file diff --git a/.github/workflows/changelog_verifier.yml b/.github/workflows/changelog_verifier.yml new file mode 100644 index 000000000000..96f99f17b016 --- /dev/null +++ b/.github/workflows/changelog_verifier.yml @@ -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" diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000000..050e5ac2f0d2 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,68 @@ +# CHANGELOG +Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) + +## [Unreleased] +### 💥 Breaking Changes + +### Deprecations + +### 🛡 Security + +### 📈 Features/Enhancements + +### 🐛 Bug Fixes + +### 🚞 Infrastructure + +### 📝 Documentation + +### 🛠 Maintenance + +### 🪛 Refactoring + +### 🔩 Tests + +## [2.x] +### 💥 Breaking Changes + +### Deprecations + +### 🛡 Security + +* Use a forced CSP-compliant interpreter with Vega visualizations ([#2352](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2352)) +* Bump moment-timezone from 0.5.34 to 0.5.37 ([#2361](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2361)) +* [CVE-2022-33987] Upgrade geckodriver to 3.0.2 ([#2166](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2166)) + +### 📈 Features/Enhancements + +* Add updated_at column to objects' tables ([#1218](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/1218)) + +### 🐛 Bug Fixes + +* [Viz Builder] Fixes time series for new chart types ([#2309](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2309)) +* [Viz Builder] Add index pattern info when loading embeddable ([#2363](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2363)) +* Fixes management app breadcrumb error ([#2344](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2344)) + +### 🚞 Infrastructure + +* Add path ignore for markdown files for CI ([#2312](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2312)) +* Updating WS scans to ignore BWC artifacts in `cypress` ([#2408](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2408)) + + +### 📝 Documentation + +* README.md for saving index pattern relationship ([#2276](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2276)) +* Remove extra typo from README. ([#2403](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2403)) + +### 🛠 Maintenance + +* Increment from 2.3 to 2.4. ([#2295](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2295)) + +### 🪛 Refactoring + +### 🔩 Tests + +* Update caniuse to fix failed integration tests ([#2322](/~https://github.com/opensearch-project/OpenSearch-Dashboards/pull/2322)) + +[Unreleased]: /~https://github.com/opensearch-project/OpenSearch-Dashboards/compare/2.3.0...HEAD +[2.x]: /~https://github.com/opensearch-project/OpenSearch-Dashboards/compare/2.3.0...2.x