-
Notifications
You must be signed in to change notification settings - Fork 2k
Add release management page to the documentation #21001
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
alamb
wants to merge
2
commits into
apache:main
Choose a base branch
from
alamb:alamb/backport_instructions
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+133
−52
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| <!--- | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| --> | ||
|
|
||
| # Release Management | ||
|
|
||
| This page describes DataFusion release branches and backports. For the | ||
| maintainer release guide, including release candidate artifacts, voting, and | ||
| publication, see [the release process README in `dev/release`]. | ||
|
|
||
| ## Overview | ||
|
|
||
| DataFusion typically has a major release about once per month, including | ||
| breaking API changes. Patch releases are made on an ad hoc basis, but we try to | ||
| avoid them because major releases are frequent. | ||
|
|
||
| New development happens on the [`main` branch]. Releases are made from release | ||
| branches named `branch-NN`, such as [`branch-50`] for the `50.x.y` release | ||
| series. | ||
|
|
||
| In general: | ||
|
|
||
| - New features land on [`main`] | ||
| - Patch releases are cut from the corresponding `branch-NN` | ||
| - Only targeted, low-risk fixes should be added to a release branch | ||
|
|
||
| Changes reach a release branch in one of two ways: | ||
|
|
||
| - (Most common) Fix the issue on `main` and then backport the merged change to the release branch | ||
| - Fix the issue on the release branch and then forward-port the change to `main` | ||
|
|
||
| Releases are coordinated in a GitHub issue, such as the | ||
| [release issue for 50.3.0]. If you think a fix should be included in a patch | ||
| release, discuss it on the relevant tracking issue first. You can also open the | ||
| backport PR first and then link it from the tracking issue. | ||
|
|
||
| To prepare for a new release series, maintainers: | ||
|
|
||
| - Create a new branch from `main`, such as `branch-50`, in the Apache repository | ||
| - Continue merging new features to `main` | ||
| - Prepare the release branch for release by updating versions, changelog content, | ||
| and any additional release-specific fixes via the | ||
| [Backport Workflow](#backport-workflow) | ||
| - Create release candidate artifacts from the release branch | ||
| - After approval, publish to crates.io, ASF distribution servers, and Git tags | ||
|
|
||
| ## Backport Workflow | ||
|
|
||
| The usual workflow is: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. from my experience if backport(s) happened, should we also create a new tag, new RC and new voting process?
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and also update the change lists |
||
|
|
||
| 1. Fix on `main` first, and merge the fix via a normal PR workflow. | ||
| 2. Cherry-pick the merged commit onto the release branch. | ||
| 3. Open a backport PR targeting the release branch (examples below). | ||
|
|
||
| - [Example backport PR] | ||
| - [Additional backport PR example] | ||
|
|
||
| ### Inputs | ||
|
|
||
| To backport a change, gather the following information: | ||
|
|
||
| - Target branch, such as `apache/branch-52` | ||
| - The release tracking issue URL, such as https://github.com/apache/datafusion/issues/19692 | ||
| - The original PR URL, such as https://github.com/apache/datafusion/pull/20192 | ||
| - Optional explicit commit SHA to backport | ||
|
|
||
| ### Apply the Backport | ||
|
|
||
| Start from the target release branch, create a dedicated backport branch, and | ||
| use `git cherry-pick`. For example, to backport PR #1234 to `branch-52` when | ||
| the commit SHA is `abc123`, run: | ||
|
|
||
| ```bash | ||
| git checkout apache/branch-52 | ||
| git checkout -b alamb/backport_1234 | ||
| git cherry-pick abc123 | ||
| ``` | ||
|
|
||
| ### Test | ||
|
|
||
| Run tests as described in the [testing documentation]. | ||
|
|
||
| ### Open the PR | ||
|
|
||
| Create a PR against the release branch, not `main`, and prefix it with | ||
| `[branch-NN]` to show which release branch the backport targets. For example: | ||
|
|
||
| - `[branch-52] fix: validate inter-file ordering in eq_properties() (#20329)` | ||
|
|
||
| Use a PR description that links the tracking issue, original PR, and target | ||
| branch, for example: | ||
|
|
||
| ```markdown | ||
| - Part of <tracking-issue-url> | ||
| - Closes <backport-issue-url> on <branch-name> | ||
|
|
||
| This PR: | ||
|
|
||
| - Backports <original-pr-url> from @<author> to the <branch-name> line | ||
| ``` | ||
|
|
||
| [`main` branch]: https://github.com/apache/datafusion/tree/main | ||
| [`branch-50`]: https://github.com/apache/datafusion/tree/branch-50 | ||
| [the release process readme in `dev/release`]: https://github.com/apache/datafusion/blob/main/dev/release/README.md | ||
| [release issue for 50.3.0]: https://github.com/apache/datafusion/issues/18072 | ||
| [example backport pr]: https://github.com/apache/datafusion/pull/18131 | ||
| [additional backport pr example]: https://github.com/apache/datafusion/pull/20792 | ||
| [testing documentation]: testing.md | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I moved this comment into a new page on the doc site for more visibility