Skip to content

Latest commit

 

History

History
87 lines (67 loc) · 2.78 KB

DEVELOPMENT.md

File metadata and controls

87 lines (67 loc) · 2.78 KB
Raw

go-control-plane Fork

This is a fork of go-control-plane. Before introducing any changes here, please create an issue or submit a change to the upstream repository, as it might impact other users.

How to Contribute

In this fork, we maintain two branches:

  • main: This branch is synced daily with the upstream repository via an automated action. The only custom addition is the job responsible for synchronization.
  • release: This branch contains all user-introduced changes. It diverges from the stable version to ensure no unreleased commits are included. Any changes you make should target this branch.

Steps to Contribute

  1. Check out the release branch.
  2. Make your changes and create a pull request targeting the release branch.
  3. Once your pull request is reviewed, merge it into the release branch.

Releasing

For standard releases, the Sync with Upstream action handles synchronization and creates custom versions whenever there’s a new upstream release. We fetch upstream tags, so, for example, v0.13.1 in this fork corresponds directly to the same version in the upstream repository.

Our job appends a custom suffix (-kong-1) to the upstream tag. If you merge a change and want to create a release, you should tag your commit using the following pattern:

<current-version>-kong-<incremented-number>

Example

The current tag is v0.13.1-kong-1. After merging your changes, you want to release a new version. You should tag your commit as:

v0.13.1-kong-2

After tagging, push the commit to the repository to finalize the release.

Conflict resolution

It might happen that automatic release job can hit a conflict. In this situation maintainer needs to resolve this manually:

Instruction

  1. Fetch current main and release branch
git fetch origin --tags
  1. Update current main branch with origin
git reset --hard origin/main
  1. Change to the release branch
git checkout release
git reset --hard origin/release
  1. Remove Untracked Files and Directories
git clean -fd
  1. Get new tag value
./.github/scripts/get-version-tags.sh

Output:

Current release tag prefix: v0.13.1
Upstream tag: v0.13.2
New tag: v0.13.2-kong-1

if tags are equal, you are going to see message "Tags are equal, no need to release" and you don't need to release/rebase anything.

  1. Rebase release branch between tags:
git rebase --onto  <Upstream tag> <Current release tag prefix> release
  1. If you encounter git conflicts, resolve them, and follow git instruction
  • resolve conflicts
  • git add
  • git rebase --continue
  1. Tag the commit
git tag <New tag>
  1. Push changes to origin
git push origin release --tags --force-with-lease