chore(changelog): new way to maintain the changelog

[vm-001]

Summary

Maintaining changelogs in a single markdown file in the repo is one of the easy ways to maintain and also keep consistency. Since Kong has multiple release versions, sometimes a bugfix needs to be backported to all the supported versions after it gets merged to the master branch. The backport bot is currently broken because of the git conflict.

I'm Introducing a new way to maintain Kong's changelog, which makes the changelog item become an individual file. The idea is, you don't get the conflict if you don't edit the same file.

Implementation details:

• CHANGELOG/changelog is a Lua script that currently provides preview, and release commands. It only requires Penlight and lyaml libraries.
• Using the template engine(provided by Penglight) which is similar to how Kong renders the nginx configuration.

Notes:

• The changelog entry file is only for demonstration and will be deleted.

[Guaris]

If you make this a string we may run into issues like:

plugin and plugins
Misspelled product names

What if you made this an enum with valid options, and included a misc keyword for things that dont fit into the options?

[vm-001]

Sounds good to me. Updated. Enum value proposal is welcome. Regarding the misc, we can use null to replace it. changelog entry that set the scope to null or missing it will be grouped to a default scope.

For example

# 1.yaml
message: add a feature
type: feature
pr: 1

# 2.yaml
message: add b feature
type: feature
scope:
pr: 2

these two changelog entries will be grouped into a default scope.

[hanshuebner]

Would you consider not requiring sequence numbers in file names? If order is important, prefixing with a date (YYYYMMDD) should do just fine. Sequence numbers in file names are not easy to maintain and create extra work in cases of conflict.

[vm-001]

Would you consider not requiring sequence numbers in file names? If order is important, prefixing with a date (YYYYMMDD) should do just fine. Sequence numbers in file names are not easy to maintain and create extra work in cases of conflict.

The changelog filename can be anything.(e.g. ${pr_number}.yaml or a-shot-description-message.yaml).

In the next phase, I will add a CI workflow to automatically extract the changelog message based on the PR title, and use the PR number as the filename, like 11279.yaml. Since PR number is already unique, so it wouldn't cause conflict.

[AndyZhang0707]

Please don't merge this PR. We will merge it on Aug 29th.

[team-gateway-bot]

The backport to release/2.8.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-release/2.8.x release/2.8.x
# Navigate to the new working tree
cd .worktrees/backport-release/2.8.x
# Create a new branch
git switch --create backport-11279-to-release/2.8.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 17c971b51a588d26c0c85dce11784ce516971024
# Push it to GitHub
git push --set-upstream origin backport-11279-to-release/2.8.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-release/2.8.x

Then, create a pull request where the base branch is release/2.8.x and the compare/head branch is backport-11279-to-release/2.8.x.

[team-gateway-bot]

The backport to release/3.0.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-release/3.0.x release/3.0.x
# Navigate to the new working tree
cd .worktrees/backport-release/3.0.x
# Create a new branch
git switch --create backport-11279-to-release/3.0.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 17c971b51a588d26c0c85dce11784ce516971024
# Push it to GitHub
git push --set-upstream origin backport-11279-to-release/3.0.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-release/3.0.x

Then, create a pull request where the base branch is release/3.0.x and the compare/head branch is backport-11279-to-release/3.0.x.

[team-gateway-bot]

The backport to release/3.1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-release/3.1.x release/3.1.x
# Navigate to the new working tree
cd .worktrees/backport-release/3.1.x
# Create a new branch
git switch --create backport-11279-to-release/3.1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 17c971b51a588d26c0c85dce11784ce516971024
# Push it to GitHub
git push --set-upstream origin backport-11279-to-release/3.1.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-release/3.1.x

Then, create a pull request where the base branch is release/3.1.x and the compare/head branch is backport-11279-to-release/3.1.x.