Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.67 KB
Raw

Local Development

This document describes how to set up the environment for local development of the Vitess Releaser tool. Note that the tool UI is intended to be self-documenting and authoritative. So if there are any discrepancies between this document and the tool UI, the tool UI should be considered the source of truth.

For testing local changes you need to create two subdirectories:

  1. Vitess fork Create a fork of Vitess in your personal GitHub account and clone it to the vitess subdirectory. When you don't use the --live flag, the tool will use this fork to create the release branches and PRs.

  2. Vitess Operator Create a fork of Vitess Operator in your personal GitHub account and clone it to the vitess-operator subdirectory. When you don't use the --live flag, the tool will use this fork to create the release branches and PRs.

Testing

vitess-releaser --date="2024-06-19" --rc=3 --release=20

You need to chose a valid release: here there should be a tag v20.0.0-RC3.

Vitess fork

Just creating a fork is not enough. The tool expects the following to be setup on your fork, which you will need to do manually:

Labels

Create the following labels on your fork: Component: General, Type: Release, Do Not Merge. This is required because the Releaser tool uses these labels to create the Release issue. The issue URL is shown in the UI that comes up.

Miscellaneous Notes

  • To restart the local test from scratch, close the Issue/PR that is generated and it will create a fresh Issue/PR.
  • We use bubbletea for the UI with lipgloss for styling.