docs: Proposal for source release process #556
Conversation
dev/release/README.md
Outdated
| @@ -17,7 +17,7 @@ specific language governing permissions and limitations | |||
| under the License. | |||
| --> | |||
|
|
|||
| # Comet Release Process | |||
| # Comet Source Release Process | |||
There was a problem hiding this comment.
What is Source means here?
There was a problem hiding this comment.
We are defining the process for making an official ASF release, which must be a source tarball.
There was a problem hiding this comment.
Here is the DataFusion 39 release, for example:
dev/release/README.md
Outdated
| - Push a release candidate tag (e.g. 0.1.0-rc1) to the Apache repository | ||
| Here are the steps, using the 0.1.0 release as an example: | ||
|
|
||
| - Create a release branch from the latest commit in main (e.g. `git checkout -b release-0.1.0`) and push to the Apache repo |
There was a problem hiding this comment.
just thinking - perhaps we can convert all steps into github commands?
|
Thanks for the review @comphead. I added the git commands for most steps. |
| Create a release branch from the latest commit in main and push to the Apache repo: | ||
|
|
||
| ```shell | ||
| get fetch apache |
There was a problem hiding this comment.
That's the name I use for my remote, but it would be good to clarify this in the docs.
$ git remote -v | grep apache
apache git@github.com:apache/datafusion-comet.git (fetch)
apache git@github.com:apache/datafusion-comet.git (push)
There was a problem hiding this comment.
Yea, I thought it might be a nickname for a particular repo. It'd be good to make it clear in the doc.
| existing Spark jobs and report any functional issues or performance regressions. | ||
|
|
||
| Another way of verifying the release is to follow the | ||
| [Comet Benchmarking Guide](https://datafusion.apache.org/comet/contributor-guide/benchmarking.html) and compare |
There was a problem hiding this comment.
it just comes to my mind if its possible to generate benches automatically per release. So Comet have a trend
* Source release process proposal * small refinement * add more detail * fix * more detail * title * prettier * ASF header * address feedback
Which issue does this PR close?
Part of #394
Rationale for this change
We want to create our first source release soon, so we need to define the process.
What changes are included in this PR?
Add proposed source release process to release documentation (rendered version).
How are these changes tested?
Not tested