|
| 1 | +<!-- |
| 2 | + Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + or more contributor license agreements. See the NOTICE file |
| 4 | + distributed with this work for additional information |
| 5 | + regarding copyright ownership. The ASF licenses this file |
| 6 | + to you under the Apache License, Version 2.0 (the |
| 7 | + "License"); you may not use this file except in compliance |
| 8 | + with the License. You may obtain a copy of the License at |
| 9 | +
|
| 10 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | +
|
| 12 | + Unless required by applicable law or agreed to in writing, |
| 13 | + software distributed under the License is distributed on an |
| 14 | + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + KIND, either express or implied. See the License for the |
| 16 | + specific language governing permissions and limitations |
| 17 | + under the License. |
| 18 | +--> |
| 19 | +<!-- START doctoc generated TOC please keep comment here to allow auto update --> |
| 20 | +<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> |
| 21 | +**Table of contents** |
| 22 | + |
| 23 | +- [Main branch is Airflow Helm Chart 2.x](#main-branch-is-airflow-helm-chart-2x) |
| 24 | +- [Contributors](#contributors) |
| 25 | + - [Why separate branches?](#why-separate-branches) |
| 26 | + - [Developing for Airflow Helm Chart 2.x](#developing-for-airflow-helm-chart-2x) |
| 27 | + - [Developing for Airflow Helm Chart 1.2x.x](#developing-for-airflow-helm-chart-12xx) |
| 28 | +- [Committers / PMCs](#committers--pmcs) |
| 29 | + - [Merging PRs targeted for Airflow Helm Chart 2.X](#merging-prs-targeted-for-airflow-helm-chart-2x) |
| 30 | + - [What do we backport to `chart/v1-2x-test` branch?](#what-do-we-backport-to-chartv1-2x-test-branch) |
| 31 | + - [Merging PRs for Airflow Chart 1.2x.x](#merging-prs-for-airflow-chart-12xx) |
| 32 | +- [Milestones for PR](#milestones-for-pr) |
| 33 | + - [Set Airflow Helm Chart 2.0.0](#set-airflow-helm-chart-200) |
| 34 | + - [Set Airflow Helm Chart 1.2x.x](#set-airflow-helm-chart-12xx) |
| 35 | + |
| 36 | +<!-- END doctoc generated TOC please keep comment here to allow auto update --> |
| 37 | + |
| 38 | +# Main branch is Airflow Helm Chart 2.x |
| 39 | + |
| 40 | +The `main` branch is for **cleanup, deprecations, and preparation** toward Airflow Helm Chart `2.x`. |
| 41 | +Airflow Helm Chart `2.x` releases will be cut from `main` branch. |
| 42 | +Airflow Helm Chart `1.2x.x` releases will be cut from [chart/v1-2x-test](https://github.com/apache/airflow/tree/chart/v1-2x-test) |
| 43 | + |
| 44 | +> [!NOTE] |
| 45 | +> We follow a staged approach: cleanup and refurbishment happens on `main` first. |
| 46 | +> Once validated, relevant changes are cherry-picked to `chart/v1-2x-test`. |
| 47 | +> This separates stability (test branch) from preparation for the next major release (main). |
| 48 | +> Each cleanup/deprecation task is tracked via individual tickets linked to the umbrella issue. |
| 49 | +
|
| 50 | +# Contributors |
| 51 | + |
| 52 | +The following section explains which branches you should target with your PR. |
| 53 | + |
| 54 | +## Why separate branches? |
| 55 | + |
| 56 | +After `1.20.0` release, we will maintain two branches for Airflow Helm Chart. |
| 57 | +Airflow Helm Chart `1.2x.x` will be the staircase versions for Airflow Helm Chart `2.x` versions. |
| 58 | + |
| 59 | +There is ongoing Airflow Helm Refurbish work, which includes cleanup, deprecations, breaking changes, and restructuring to reduce technical debt before cutting the next major release. |
| 60 | +We want to be able to merge bug-fixes and documentation changes that are relevant to the latest release of Airflow Helm Chart 1.2x series without being blocked by the ongoing work on Airflow Helm Chart 2.x. |
| 61 | +At the same time, we want to be able to merge cleanup, deprecations, and preparation work for Airflow Helm Chart 2.x on `main` without being blocked by the need to backport them to Airflow Helm Chart 1.2x series. |
| 62 | + |
| 63 | +For the refurbish work, we have a separate project in Apache Confluence: |
| 64 | + |
| 65 | +[Airflow Helm Refurbish Project in Apache Confluence](https://cwiki.apache.org/confluence/display/AIRFLOW/Helm+Refurbish) |
| 66 | + |
| 67 | +## Developing for Airflow Helm Chart 2.x |
| 68 | + |
| 69 | +PRs should target `main` branch. |
| 70 | + |
| 71 | +## Developing for Airflow Helm Chart 1.2x.x |
| 72 | + |
| 73 | +PR should target `chart/v1-2x-test` branch. |
| 74 | + |
| 75 | +> [!IMPORTANT] |
| 76 | +> The `chart/v1-2x-test` branch is **strictly for maintenance, stability, and compatibility**. |
| 77 | +> No new features will be added here. |
| 78 | +> |
| 79 | +> We do not accept new features or non-trivial refactorings. |
| 80 | +> We only accept bug-fixes and documentation changes that are relevant to the latest release. |
| 81 | +> If you want to contribute new features or non-trivial refactorings, please target `main` branch. |
| 82 | +> We will cherry-pick it to `chart/v1-2x-test` branch if we decide that it is relevant to the latest release. |
| 83 | +> `1.2x.x` will be the latest release of Airflow Helm Chart 1.2x series. |
| 84 | +> We will not cut any new major release from `chart/v1-2x-test` branch. |
| 85 | +
|
| 86 | +# Committers / PMCs |
| 87 | + |
| 88 | +The following sections explains the protocol for merging PRs. |
| 89 | + |
| 90 | +## Merging PRs targeted for Airflow Helm Chart 2.X |
| 91 | + |
| 92 | +PRs should target `main` branch. |
| 93 | +We will cherry-pick relevant changes to `chart/v1-2x-test` branch if we decide that they are relevant to the latest release. |
| 94 | + |
| 95 | + |
| 96 | +## What do we backport to `chart/v1-2x-test` branch? |
| 97 | + |
| 98 | +The `chart/v1-2x-test` branch is for development of Airflow Helm Chart `1.2x.x`. |
| 99 | +We will backport bug-fixes and documentation changes that are relevant to the latest release. |
| 100 | +We will not backport new features or non-trivial refactorings. |
| 101 | + |
| 102 | +* **Cleanup/Deprecations** cherry-pick according to version deprecation policy. |
| 103 | + * Each minor version of Airflow Helm Chart will include some level of deprecation warnings. |
| 104 | + * These warnings will mainly aim to be dropped at 2.0.0. |
| 105 | + * If agreed cleanup/deprecation is relevant to the latest release, it should be cherry-picked to `chart/v1-2x-test` branch. |
| 106 | +* **Bug-fixes** cherry-pick only those relevant to the latest chart release and not difficult to apply. |
| 107 | +* **CI changes** cherry-pick most CI changes to keep the bugfix branch up-to-date and CI green. |
| 108 | +* **Documentation changes** cherry-pick only if relevant to the latest chart release and not about features only in `main`. |
| 109 | +* **Minor refactorings in active areas** do not cherry-pick. |
| 110 | +* **New features** do not cherry-pick. |
| 111 | + |
| 112 | + |
| 113 | +## Merging PRs for Airflow Chart 1.2x.x |
| 114 | + |
| 115 | +PRs should target `chart/v1-2x-test` branch. |
| 116 | +We will not merge new features or non-trivial refactorings. |
| 117 | +We will only merge bug-fixes and documentation changes that are relevant to the latest release. |
| 118 | + |
| 119 | + |
| 120 | +# Milestones for PR |
| 121 | + |
| 122 | +## Set Airflow Helm Chart 2.0.0 |
| 123 | + |
| 124 | +Milestone will be added only to the original PR. |
| 125 | + |
| 126 | +* PR targeting `main` branch for cleanup, deprecations, preparation work, or non-trivial refactoring should be added to `Airflow Helm Chart 2.0.0` milestone. |
| 127 | + |
| 128 | +## Set Airflow Helm Chart 1.2x.x |
| 129 | + |
| 130 | +Milestone will be added only to the original PR. |
| 131 | + |
| 132 | +* PR targeting `v1-2x-test` branch should be added to relevant release accordingly `Airflow Helm Chart 1.2x.x` milestone. |
| 133 | + * The version depends on the release cycle and the decision of the maintainers such as `1.20.0`, `1.21.0`, etc. |
0 commit comments