From 1ee19bd603f4b916985b28202f9abd1981a7cec8 Mon Sep 17 00:00:00 2001 From: Datong Sun Date: Thu, 7 Sep 2023 01:35:28 -0700 Subject: [PATCH] chore(changelog): use yml to stay consistent with the rest of this repo's naming conventions --- .github/workflows/{changelog.yaml => changelog.yml} | 6 +++--- CHANGELOG/README.md | 4 ++-- CHANGELOG/changelog | 3 +-- CHANGELOG/unreleased/kong/{11360-1.yaml => 11360-1.yml} | 0 CHANGELOG/unreleased/kong/{11360-2.yaml => 11360-2.yml} | 0 CHANGELOG/unreleased/kong/{11424.yaml => 11424.yml} | 0 CHANGELOG/unreleased/kong/{11468.yaml => 11468.yml} | 0 7 files changed, 6 insertions(+), 7 deletions(-) rename .github/workflows/{changelog.yaml => changelog.yml} (92%) rename CHANGELOG/unreleased/kong/{11360-1.yaml => 11360-1.yml} (100%) rename CHANGELOG/unreleased/kong/{11360-2.yaml => 11360-2.yml} (100%) rename CHANGELOG/unreleased/kong/{11424.yaml => 11424.yml} (100%) rename CHANGELOG/unreleased/kong/{11468.yaml => 11468.yml} (100%) diff --git a/.github/workflows/changelog.yaml b/.github/workflows/changelog.yml similarity index 92% rename from .github/workflows/changelog.yaml rename to .github/workflows/changelog.yml index 0fcd8ed8a967..9d716c9e11b7 100644 --- a/.github/workflows/changelog.yaml +++ b/.github/workflows/changelog.yml @@ -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') }} @@ -44,4 +44,4 @@ jobs: with: jsonSchemaFile: CHANGELOG/schema.json yamlFiles: | - CHANGELOG/unreleased/*/*.yaml + CHANGELOG/unreleased/*/*.yml diff --git a/CHANGELOG/README.md b/CHANGELOG/README.md index ead8a94074c7..c0f8eb59ceb6 100644 --- a/CHANGELOG/README.md +++ b/CHANGELOG/README.md @@ -6,7 +6,7 @@ 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. @@ -14,7 +14,7 @@ The `kong/CHANGELOG.md` now is deprecated. 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 diff --git a/CHANGELOG/changelog b/CHANGELOG/changelog index 87e93e2c46d8..b02727c51225 100755 --- a/CHANGELOG/changelog +++ b/CHANGELOG/changelog @@ -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) diff --git a/CHANGELOG/unreleased/kong/11360-1.yaml b/CHANGELOG/unreleased/kong/11360-1.yml similarity index 100% rename from CHANGELOG/unreleased/kong/11360-1.yaml rename to CHANGELOG/unreleased/kong/11360-1.yml diff --git a/CHANGELOG/unreleased/kong/11360-2.yaml b/CHANGELOG/unreleased/kong/11360-2.yml similarity index 100% rename from CHANGELOG/unreleased/kong/11360-2.yaml rename to CHANGELOG/unreleased/kong/11360-2.yml diff --git a/CHANGELOG/unreleased/kong/11424.yaml b/CHANGELOG/unreleased/kong/11424.yml similarity index 100% rename from CHANGELOG/unreleased/kong/11424.yaml rename to CHANGELOG/unreleased/kong/11424.yml diff --git a/CHANGELOG/unreleased/kong/11468.yaml b/CHANGELOG/unreleased/kong/11468.yml similarity index 100% rename from CHANGELOG/unreleased/kong/11468.yaml rename to CHANGELOG/unreleased/kong/11468.yml