Skip to content

Commit 4e6e71e

Browse files
Updates changelog structure to adhere to opensearch release-notes guideline (#2271)
* Updates changelog structure to adhere to opensearch release-notes guidelines Signed-off-by: Darshit Chanpura <[email protected]> * Updates changelog workflow Signed-off-by: Darshit Chanpura <[email protected]> * Updates dependabot changelog lookup section Signed-off-by: Darshit Chanpura <[email protected]> --------- Signed-off-by: Darshit Chanpura <[email protected]>
1 parent 5ac567e commit 4e6e71e

File tree

3 files changed

+26
-18
lines changed

3 files changed

+26
-18
lines changed

.github/workflows/changelog_verifier.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: "Changelog Verifier"
22
on:
33
pull_request:
4-
types: [opened, edited, reopened]
4+
types: [opened, edited, review_requested, synchronize, reopened, ready_for_review, labeled, unlabeled]
55

66
jobs:
77
# Enforces the update of a changelog file on every pull request

.github/workflows/dependabot_pr.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ jobs:
2626
uses: dangoslen/dependabot-changelog-helper@v4
2727
with:
2828
version: 'Unreleased 3.x'
29+
sectionHeader: "Maintenance"
2930

3031
- name: Commit the changes
3132
uses: stefanzweifel/git-auto-commit-action@v6

CHANGELOG.md

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,35 @@ All notable changes to this project are documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to the [Semantic Versioning](https://semver.org/spec/v2.0.0.html). See the [CONTRIBUTING guide](./CONTRIBUTING.md#Changelog) for instructions on how to add changelog entries.
55

66
## [Unreleased 3.x]
7-
### Added
87

8+
### Features
99

10-
### Changed
11-
- Changes to show all index patterns in index permission panel in role view ([#1303](https://github.com/opensearch-project/security-dashboards-plugin/issues/1303),[#1891](https://github.com/opensearch-project/security-dashboards-plugin/issues/1891))
12-
- Added missing index permissions in the list ([#1969](https://github.com/opensearch-project/security-dashboards-plugin/issues/1969))
1310

14-
### Dependencies
15-
- Bump `actions/checkout` from 2 to 4 ([#2260](https://github.com/opensearch-project/security-dashboards-plugin/pull/2260))
16-
- Bump `codecov/codecov-action` from 4 to 5 ([#2263](https://github.com/opensearch-project/security-dashboards-plugin/pull/2263))
17-
- Bump `SvanBoxel/delete-merged-branch` from b77e873cee00b09f55cc553bd24aae5f8dfc9157 to 2b5b058e3db41a3328fd9a6a58fd4c2545a14353 ([#2265](https://github.com/opensearch-project/security-dashboards-plugin/pull/2265))
18-
- Bump `actions/github-script` from 6 to 7 ([#2259](https://github.com/opensearch-project/security-dashboards-plugin/pull/2259))
19-
- Bump `tibdex/github-app-token` from 1.5.0 to 2.1.0 ([#2262](https://github.com/opensearch-project/security-dashboards-plugin/pull/2262))
20-
- Bump `stefanzweifel/git-auto-commit-action` from 5 to 6 ([#2268](https://github.com/opensearch-project/security-dashboards-plugin/pull/2268))
21-
- Bump `derek-ho/start-opensearch` from 6 to 7 ([#2267](https://github.com/opensearch-project/security-dashboards-plugin/pull/2267))
11+
### Enhancements
2212

23-
### Deprecated
13+
* Changes to show all index patterns in index permission panel in role view ([#1303](https://github.com/opensearch-project/security-dashboards-plugin/issues/1303),[#1891](https://github.com/opensearch-project/security-dashboards-plugin/issues/1891))
14+
* Added missing index permissions in the list ([#1969](https://github.com/opensearch-project/security-dashboards-plugin/issues/1969))
2415

25-
### Removed
2616

27-
### Fixed
17+
### Bug Fixes
2818

29-
### Security
3019

31-
[Unreleased 3.x]: https://github.com/opensearch-project/security-dashboards-plugin/compare/3.0...main
20+
### Refactoring
21+
22+
23+
### Maintenance
24+
25+
* Bump `actions/checkout` from 2 to 4 ([#2260](https://github.com/opensearch-project/security-dashboards-plugin/pull/2260))
26+
* Bump `codecov/codecov-action` from 4 to 5 ([#2263](https://github.com/opensearch-project/security-dashboards-plugin/pull/2263))
27+
* Bump `SvanBoxel/delete-merged-branch` from b77e873cee00b09f55cc553bd24aae5f8dfc9157 to 2b5b058e3db41a3328fd9a6a58fd4c2545a14353 ([#2265](https://github.com/opensearch-project/security-dashboards-plugin/pull/2265))
28+
* Bump `actions/github-script` from 6 to 7 ([#2259](https://github.com/opensearch-project/security-dashboards-plugin/pull/2259))
29+
* Bump `tibdex/github-app-token` from 1.5.0 to 2.1.0 ([#2262](https://github.com/opensearch-project/security-dashboards-plugin/pull/2262))
30+
* Bump `stefanzweifel/git-auto-commit-action` from 5 to 6 ([#2268](https://github.com/opensearch-project/security-dashboards-plugin/pull/2268))
31+
* Bump `derek-ho/start-opensearch` from 6 to 7 ([#2267](https://github.com/opensearch-project/security-dashboards-plugin/pull/2267))
32+
33+
34+
### Documentation
35+
36+
37+
38+
[Unreleased 3.x]: https://github.com/opensearch-project/security-dashboards-plugin/compare/3.1...main

0 commit comments

Comments
 (0)