pitrou commented on code in PR #13308:
URL: https://github.com/apache/arrow/pull/13308#discussion_r891110796
##########
docs/source/developers/release.rst:
##########
@@ -87,12 +87,55 @@ These are the different steps that are required to create a
release candidate.
# Curate the release
# The end of the generated report shows the jira tickets with wrong
version number assigned.
Review Comment:
Nit: capitalization
```suggestion
# The end of the generated report shows the JIRA tickets with wrong
version number assigned.
```
##########
docs/source/developers/release.rst:
##########
@@ -87,12 +87,55 @@ These are the different steps that are required to create a
release candidate.
# Curate the release
# The end of the generated report shows the jira tickets with wrong
version number assigned.
archery release curate <version>
-
- # Checkout release branch
- # Use master for major releases
- git checkout -b release-4.0.0 master
- # Use maintenance branches like maint-4.0.x for patch releases
- git checkout -b release-4.0.1 maint-4.0.x
+
+
+Creating a Release Candidate
+============================
+
+These are the different steps that are required to create a release candidate.
+
+For the initial Release Candidate, we will create a maintenance branch from
master.
+Follow up Release Candidates will update the maintenance branch cherry-picking
+specific commits.
+
+We have implemented a Feature Freeze policy between Release Candidates.
+This means that, in general, we will only add fixes between Release Candidates.
+In rare cases, critical features can be added between release candidates, if
+there is community consensus.
+
+Create or update the corresponding maintenance branches:
+
+.. tab-set::
+
+ .. tab-item:: Initial Release Candidate
+
+ .. code-block::
+
+ # Execute the following from an up to date master branch.
+ # This will create a branch locally called maint-X.Y.Z
+ archery release --jira-cache /tmp/jiracache cherry-pick X.Y.Z
--execute
+ # Push the maintenance branch to the remote repository
+ git push -u apache maint-X.Y.Z
+
+ .. tab-item:: Follow up Release Candidates
+
+ .. code-block::
+
+ # First run on dry-mode to see what are the commits that will be
cherry-pick.
Review Comment:
```suggestion
# First run in dry-mode to see which the commits will be
cherry-picked.
```
##########
docs/source/developers/release.rst:
##########
@@ -87,12 +87,55 @@ These are the different steps that are required to create a
release candidate.
# Curate the release
# The end of the generated report shows the jira tickets with wrong
version number assigned.
archery release curate <version>
-
- # Checkout release branch
- # Use master for major releases
- git checkout -b release-4.0.0 master
- # Use maintenance branches like maint-4.0.x for patch releases
- git checkout -b release-4.0.1 maint-4.0.x
+
+
+Creating a Release Candidate
+============================
+
+These are the different steps that are required to create a release candidate.
+
+For the initial Release Candidate, we will create a maintenance branch from
master.
+Follow up Release Candidates will update the maintenance branch cherry-picking
+specific commits.
+
+We have implemented a Feature Freeze policy between Release Candidates.
+This means that, in general, we will only add fixes between Release Candidates.
+In rare cases, critical features can be added between release candidates, if
+there is community consensus.
+
+Create or update the corresponding maintenance branches:
Review Comment:
Why "branches"? Are there several of them?
##########
docs/source/developers/release.rst:
##########
@@ -87,12 +87,55 @@ These are the different steps that are required to create a
release candidate.
# Curate the release
# The end of the generated report shows the jira tickets with wrong
version number assigned.
archery release curate <version>
-
- # Checkout release branch
- # Use master for major releases
- git checkout -b release-4.0.0 master
- # Use maintenance branches like maint-4.0.x for patch releases
- git checkout -b release-4.0.1 maint-4.0.x
+
+
+Creating a Release Candidate
+============================
+
+These are the different steps that are required to create a release candidate.
+
+For the initial Release Candidate, we will create a maintenance branch from
master.
+Follow up Release Candidates will update the maintenance branch cherry-picking
+specific commits.
+
+We have implemented a Feature Freeze policy between Release Candidates.
+This means that, in general, we will only add fixes between Release Candidates.
+In rare cases, critical features can be added between release candidates, if
+there is community consensus.
+
+Create or update the corresponding maintenance branches:
Review Comment:
Also make these subsections?
##########
docs/source/developers/release.rst:
##########
@@ -87,12 +87,55 @@ These are the different steps that are required to create a
release candidate.
# Curate the release
# The end of the generated report shows the jira tickets with wrong
version number assigned.
archery release curate <version>
-
- # Checkout release branch
- # Use master for major releases
- git checkout -b release-4.0.0 master
- # Use maintenance branches like maint-4.0.x for patch releases
- git checkout -b release-4.0.1 maint-4.0.x
+
+
+Creating a Release Candidate
+============================
+
+These are the different steps that are required to create a release candidate.
+
+For the initial Release Candidate, we will create a maintenance branch from
master.
+Follow up Release Candidates will update the maintenance branch cherry-picking
+specific commits.
+
+We have implemented a Feature Freeze policy between Release Candidates.
+This means that, in general, we will only add fixes between Release Candidates.
+In rare cases, critical features can be added between release candidates, if
+there is community consensus.
+
+Create or update the corresponding maintenance branches:
+
+.. tab-set::
+
+ .. tab-item:: Initial Release Candidate
+
+ .. code-block::
+
+ # Execute the following from an up to date master branch.
+ # This will create a branch locally called maint-X.Y.Z
Review Comment:
What is "X.Y.Z" supposed to stand for? It's not clear to me.
##########
docs/source/developers/release.rst:
##########
@@ -87,12 +87,55 @@ These are the different steps that are required to create a
release candidate.
# Curate the release
# The end of the generated report shows the jira tickets with wrong
version number assigned.
archery release curate <version>
-
- # Checkout release branch
- # Use master for major releases
- git checkout -b release-4.0.0 master
- # Use maintenance branches like maint-4.0.x for patch releases
- git checkout -b release-4.0.1 maint-4.0.x
+
+
+Creating a Release Candidate
+============================
+
+These are the different steps that are required to create a release candidate.
+
+For the initial Release Candidate, we will create a maintenance branch from
master.
+Follow up Release Candidates will update the maintenance branch cherry-picking
+specific commits.
+
+We have implemented a Feature Freeze policy between Release Candidates.
+This means that, in general, we will only add fixes between Release Candidates.
Review Comment:
```suggestion
This means that, in general, we should only add bug fixes between Release
Candidates.
```
##########
docs/source/developers/release.rst:
##########
@@ -87,12 +87,55 @@ These are the different steps that are required to create a
release candidate.
# Curate the release
# The end of the generated report shows the jira tickets with wrong
version number assigned.
archery release curate <version>
-
- # Checkout release branch
- # Use master for major releases
- git checkout -b release-4.0.0 master
- # Use maintenance branches like maint-4.0.x for patch releases
- git checkout -b release-4.0.1 maint-4.0.x
+
+
+Creating a Release Candidate
+============================
+
+These are the different steps that are required to create a release candidate.
+
+For the initial Release Candidate, we will create a maintenance branch from
master.
+Follow up Release Candidates will update the maintenance branch cherry-picking
+specific commits.
+
+We have implemented a Feature Freeze policy between Release Candidates.
+This means that, in general, we will only add fixes between Release Candidates.
+In rare cases, critical features can be added between release candidates, if
Review Comment:
Please use consistent capitalization for "release candidates" / "Release
Candidates".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
