Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 23 additions & 1 deletion docs/source/contributor-guide/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ instructions on each step.
- [ ] Promote Maven artifacts to production
- [ ] Push the release tag
- [ ] Bring the finalized change log into main
- [ ] Update the download page
- [ ] Close the vote and announce the release
- [ ] Post release:
- [ ] Register the release with Apache Reporter
Expand Down Expand Up @@ -443,6 +444,9 @@ deployed to https://datafusion.apache.org/comet/ by the documentation publishing
Note that the download links in the installation guide will not work until the release is finalized, but having the
documentation available could be useful for anyone testing out the release candidate during the voting period.

The [Download](../download.md) page is not part of this step. It is updated only after
the release is published; see [Update the download page](#update-the-download-page).

## Publishing the Release Candidate

This part of the process can mostly only be performed by a PMC member.
Expand Down Expand Up @@ -595,11 +599,29 @@ git tag 0.13.0
git push apache 0.13.0
```

### Update the download page

ASF release policy requires the project website to have a download page for the source release, and the
announcement to link to it. Update `docs/source/download.md` to point at the new release: change the version in the
links and commands, the changelog link and the user guide links, and create a pull request against `main`.

Wait at least one hour after the tarball is uploaded to the release repository, so that it has reached
`downloads.apache.org` and the mirrors, before merging the pull request. Do not merge it before the release is
published, because ASF release policy forbids linking to unreleased packages.

Check that the tarball link redirects to a mirror and that the signature, checksum and `KEYS` links resolve. The
tarball must be linked through the mirror system (`https://www.apache.org/dyn/closer.lua/...`), and the signature,
checksum and `KEYS` links must point at `https://downloads.apache.org/`, not at a mirror. Send the announcement
email only after the updated page is live on the website.

### Announce the release

Reply to the vote thread to close the vote and announce the release. The announcement email should include:

- The release version
- A link to the release notes / changelog
- A link to the download page or Maven coordinates
- A link to the [Download](../download.md) page for the source release (required by
ASF release policy), and optionally the Maven coordinates
- Thanks to everyone who contributed and voted

## Post Release
Expand Down
63 changes: 63 additions & 0 deletions docs/source/download.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<!---
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.
-->

# Download

Apache DataFusion Comet is released as source code. The current release is **1.2.0**.

## Source release

- [apache-datafusion-comet-1.2.0.tar.gz](https://www.apache.org/dyn/closer.lua/datafusion/datafusion-comet-1.2.0/apache-datafusion-comet-1.2.0.tar.gz?action=download) (source tarball)
- [apache-datafusion-comet-1.2.0.tar.gz.asc](https://downloads.apache.org/datafusion/datafusion-comet-1.2.0/apache-datafusion-comet-1.2.0.tar.gz.asc) (PGP signature)
- [apache-datafusion-comet-1.2.0.tar.gz.sha512](https://downloads.apache.org/datafusion/datafusion-comet-1.2.0/apache-datafusion-comet-1.2.0.tar.gz.sha512) (SHA-512 checksum)

The tarball is served from the nearest Apache mirror. The signature and checksum are served by the Apache Software
Foundation and must not be taken from a mirror. The public keys of the release managers are in the
[KEYS](https://downloads.apache.org/datafusion/KEYS) file.

The release notes are in the [changelog](changelog/1.2.0.md).
See [Building Comet From Source](user-guide/1.2/source.md) for how to build the tarball.

## Verifying the download

It is essential that you verify the integrity of the downloaded file using the PGP signature and the checksum.

```console
# Import the public keys of the release managers
curl -O "https://downloads.apache.org/datafusion/KEYS"
gpg --import KEYS
# Verify the signature and the checksum
gpg --verify apache-datafusion-comet-1.2.0.tar.gz.asc apache-datafusion-comet-1.2.0.tar.gz
shasum -a 512 --check apache-datafusion-comet-1.2.0.tar.gz.sha512
```

The `gpg --verify` command should report a good signature. See the
[ASF guide to verifying releases](https://www.apache.org/info/verification.html) for more detail.

## Convenience binaries

Pre-built Comet jar files for Linux are published to
[Maven Central](https://central.sonatype.com/namespace/org.apache.datafusion) as a convenience. They are built from
the source release above. See the [installation guide](user-guide/1.2/installation.md) for the links and for the
supported Spark versions.

## Older releases

Only the current release is kept on the mirrors. All earlier releases are permanently available from the
[Apache archive](https://archive.apache.org/dist/datafusion/).
1 change: 1 addition & 0 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ Speeds up your existing Spark queries by running them on Apache Arrow columnar d
:hidden:

User Guide <user-guide/index>
Download <download>
Contributor Guide <contributor-guide/index>
Changelog <changelog/index>
About <about/index>
Expand Down
7 changes: 3 additions & 4 deletions docs/source/user-guide/latest/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,12 @@ To use this version of Comet, see the following section on building from the Git

<!-- IF_RELEASE -->

Official source releases can be downloaded from https://dist.apache.org/repos/dist/release/datafusion/
Official source releases are available from the [Download](../../download.md) page,
together with the signature, checksum and instructions for verifying the download.

```console
# Pick the latest version
# Pick the version you downloaded
export COMET_VERSION=$COMET_VERSION
# Download the tarball
curl -O "https://dist.apache.org/repos/dist/release/datafusion/datafusion-comet-$COMET_VERSION/apache-datafusion-comet-$COMET_VERSION.tar.gz"
# Unpack
tar -xzf apache-datafusion-comet-$COMET_VERSION.tar.gz
cd apache-datafusion-comet-$COMET_VERSION
Expand Down