Skip to content

Commit

Permalink
chore(changelog): use yml to stay consistent with the rest of this
Browse files Browse the repository at this point in the history
repo's naming conventions
  • Loading branch information
dndx committed Sep 7, 2023
1 parent c5b4106 commit 1ee19bd
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ jobs:
with:
fetch-depth: 2

- name: Retrives changed files in CHANGELOG/unreleased/**/*.yaml
- name: Retrives changed files in CHANGELOG/unreleased/**/*.yml
id: changelog-check
uses: tj-actions/changed-files@2f7246cb26e8bb6709b6cbfc1fec7febfe82e96a # v37
with:
files: 'CHANGELOG/unreleased/**/*.yaml'
files: 'CHANGELOG/unreleased/**/*.yml'

- name: Requires a changelog file if 'skip-changelog' label is not added
if: ${{ !contains(github.event.*.labels.*.name, 'skip-changelog') }}
Expand All @@ -44,4 +44,4 @@ jobs:
with:
jsonSchemaFile: CHANGELOG/schema.json
yamlFiles: |
CHANGELOG/unreleased/*/*.yaml
CHANGELOG/unreleased/*/*.yml
4 changes: 2 additions & 2 deletions CHANGELOG/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ The `kong/CHANGELOG.md` now is deprecated.

## How to add a changelog file for your PR?

1/ Copy the `changelog-template.yaml` file and rename with your PR number or a short message as the filename. For example, `11279.yaml`, `introduce-a-new-changelog-system.yaml`. (Prefer using PR number as it's already unique and wouldn't introduce conflict)
1/ Copy the `changelog-template.yml` file and rename with your PR number or a short message as the filename. For example, `11279.yml`, `introduce-a-new-changelog-system.yml`. (Prefer using PR number as it's already unique and wouldn't introduce conflict)

2/ Fill out the changelog template.


The description of the changelog file field, please follow the `schema.json` for more details.

- message: Message of the changelog
- type: Changelog type. (`feature`, `bugfix`, `dependency`, `deprecation`, `breaking_change`)
- type: Changelog type. (`feature`, `bugfix`, `dependency`, `deprecation`, `breaking_change`, `performance`)
- scope: Changelog scope. (`Core`, `Plugin`, `PDK`, `Admin API`, `Performance`, `Configuration`, `Clustering`)
- prs: List of associated GitHub PRs
- issues: List of associated GitHub issues
Expand Down
3 changes: 1 addition & 2 deletions CHANGELOG/changelog
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ end


local function is_yaml(filename)
return pl_stringx.endswith(filename, ".yaml") or
pl_stringx.endswith(filename, ".yml")
return pl_stringx.endswith(filename, ".yml")
end

local function is_empty_table(t)
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 1ee19bd

Please sign in to comment.