DataFusion typically has major releases around once per month, including breaking API changes.
Patch releases are made on an adhoc basis, but we try and avoid them given the frequent major releases.
branch-37 in the Apache repository (not in a fork)branch-* branch?If you would like to propose your change for inclusion in a release branch for a patch release:
main branch and wait for its approval and merge.main, branch from most recent release branch (e.g. branch-37), cherry-pick the commit and create a PR targeting the release branch example backport PR.git@github.com:apache/datafusion.git add as git remote apache.repo accessSee instructions at https://infra.apache.org/release-signing.html#generate for generating keys.
Committers can add signing keys in Subversion client with their ASF account. e.g.:
$ svn co https://dist.apache.org/repos/dist/dev/datafusion $ cd datafusion $ editor KEYS $ svn ci KEYS
Follow the instructions in the header of the KEYS file to append your key. Here is an example:
(gpg --list-sigs "John Doe" && gpg --armor --export "John Doe") >> KEYS svn commit KEYS -m "Add key for John Doe"
As part of the Apache governance model, official releases consist of signed source tarballs approved by the PMC.
We then use the code in the approved artifacts to release to crates.io and PyPI.
We maintain a CHANGELOG.md so our users know what has been changed between releases.
You will need a GitHub Personal Access Token for the following steps. Follow these instructions to generate one if you do not already have one.
The changelog is generated using a Python script. There is a dependency on PyGitHub, which can be installed using pip:
pip3 install PyGitHub
To generate the changelog, set the GITHUB_TOKEN environment variable to a valid token and then run the script providing two commit ids or tags followed by the version number of the release being created. The following example generates a change log of all changes between the first commit and the current HEAD revision.
export GITHUB_TOKEN=<your-token-here> ./dev/release/generate-changelog.py 24.0.0 HEAD 25.0.0 > dev/changelog/25.0.0.md
This script creates a changelog from GitHub PRs based on the labels associated with them as well as looking for titles starting with feat:, fix:, or docs:.
Once the change log is generated, run prettier to format the document:
prettier -w dev/changelog/25.0.0md
Prepare a PR to update CHANGELOG.md and versions to reflect the planned release.
See #9697 for an example.
Here are the commands that could be used to prepare the 38.0.0 release:
Checkout the main commit to be released
git fetch apache git checkout apache/main
Update datafusion version in datafusion/Cargo.toml to 38.0.0:
./dev/update_datafusion_versions.py 38.0.0
Lastly commit the version change:
git commit -a -m 'Update version'
After the PR gets merged, you are ready to create release artifacts based off the merged commit.
(Note you need to be a committer to run these scripts as they upload to the apache svn distribution servers)
Pick numbers in sequential order, with 0 for rc0, 1 for rc1, etc.
While the official release artifacts are signed tarballs and zip files, we also tag the commit it was created for convenience and code archaeology.
Using a string such as 38.0.0 as the <version>, create and push the tag by running these commands:
git fetch apache git tag <version>-<rc> apache/main # push tag to Github remote git push apache <version>
Run create-tarball.sh with the <version> tag and <rc> and you found in previous steps:
GH_TOKEN=<TOKEN> ./dev/release/create-tarball.sh 38.0.0 0
The create-tarball.sh script
creates and uploads all release candidate artifacts to the datafusion dev location on the apache distribution svn server
provide you an email template to send to dev@datafusion.apache.org for release voting.
Send the email output from the script to dev@datafusion.apache.org.
For the release to become “official” it needs at least three PMC members to vote +1 on it.
The dev/release/verify-release-candidate.sh is a script in this repository that can assist in the verification process. Run it like:
./dev/release/verify-release-candidate.sh 38.0.0 0
If the release is not approved, fix whatever the problem is, merge changelog changes into main if there is any and try again with the next RC number.
NOTE: steps in this section can only be done by PMC members.
Move artifacts to the release location in SVN, e.g. https://dist.apache.org/repos/dist/release/datafusion/datafusion-38.0.0/, using the release-tarball.sh script:
./dev/release/release-tarball.sh 38.0.0 0
Congratulations! The release is now official!
Tag the same release candidate commit with the final release tag
git co apache/38.0.0-rc0 git tag 38.0.0 git push apache 38.0.0
Only approved releases of the tarball should be published to crates.io, in order to conform to Apache Software Foundation governance standards.
An Arrow committer can publish this crate after an official project release has been made to crates.io using the following instructions.
Follow these instructions to create an account and login to crates.io before asking to be added as an owner to all of the DataFusion crates.
Download and unpack the official release tarball
Verify that the Cargo.toml in the tarball contains the correct version (e.g. version = "38.0.0") and then publish the crates by running the script release-crates.sh in a directory extracted from the source tarball that was voted on. Note that this script doesn't work if run in a Git repo.
Alternatively the crates can be published one at a time with the following commands. Crates need to be published in the correct order as shown in this diagram.
To update this diagram, manually edit the dependencies in crate-deps.dot and then run:
dot -Tsvg dev/release/crate-deps.dot > dev/release/crate-deps.svg
(cd datafusion/common && cargo publish) (cd datafusion/expr && cargo publish) (cd datafusion/execution && cargo publish) (cd datafusion/physical-expr-common && cargo publish) (cd datafusion/functions-aggregate && cargo publish) (cd datafusion/physical-expr && cargo publish) (cd datafusion/functions && cargo publish) (cd datafusion/functions-nested && cargo publish) (cd datafusion/sql && cargo publish) (cd datafusion/optimizer && cargo publish) (cd datafusion/common-runtime && cargo publish) (cd datafusion/physical-plan && cargo publish) (cd datafusion/core && cargo publish) (cd datafusion/proto-common && cargo publish) (cd datafusion/proto && cargo publish) (cd datafusion/substrait && cargo publish)
The CLI needs a --no-verify argument because build.rs generates source into the src directory.
(cd datafusion-cli && cargo publish --no-verify)
Run publish_homebrew.sh to publish datafusion-cli on Homebrew. In order to do so it is necessary to fork the homebrew-core repo https://github.com/Homebrew/homebrew-core/, have Homebrew installed on your macOS/Linux/WSL2 and properly configured and have a Github Personal Access Token that has permission to file pull requests in the homebrew-core repo.
homebrew-core repoGo to https://github.com/Homebrew/homebrew-core/ and fork the repo.
Please visit https://brew.sh/ to obtain Homebrew. In addition to that please check out https://docs.brew.sh/Homebrew-on-Linux if you are on Linux or WSL2.
Before running the script make sure that you can run the following command in your bash to make sure that brew has been installed and configured properly:
brew --version
To create a Github Personal Access Token, please visit https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token for instructions.
homebrew-core in the list of repos under Selected repositories.After all of the above is complete execute the following command:
dev/release/publish_homebrew.sh <version> <github-user> <github-token> <homebrew-default-branch-name>
Note that sometimes someone else has already submitted a PR to update the datafusion formula in homebrew. In this case you will get an error with a message that your PR is a duplicate of an existing one. In this case no further action is required.
Alternatively manually submit a simple PR to update tag and commit hash for the datafusion formula in homebrew-core. Here is an example PR: https://github.com/Homebrew/homebrew-core/pull/89562.
Call the vote on the Arrow dev list by replying to the RC voting thread. The reply should have a new subject constructed by adding [RESULT] prefix to the old subject line.
Sample announcement template:
The vote has passed with <NUMBER> +1 votes. Thank you to all who helped with the release verification.
Add the release to https://reporter.apache.org/addrelease.html?datafusion using the version number e.g. 38.0.0.
The release information is used to generate a template for a board report (see example from Apache Arrow project here).
See the ASF documentation on when to archive for more information.
dev svnRelease candidates should be deleted once the release is published.
Get a list of DataFusion release candidates:
svn ls https://dist.apache.org/repos/dist/dev/datafusion
Delete a release candidate:
svn delete -m "delete old DataFusion RC" https://dist.apache.org/repos/dist/dev/datafusion/apache-datafusion-38.0.0-rc1/
release svnOnly the latest release should be available. Delete old releases after publishing the new release.
Get a list of DataFusion releases:
svn ls https://dist.apache.org/repos/dist/release/datafusion
Delete a release:
svn delete -m "delete old DataFusion release" https://dist.apache.org/repos/dist/release/datafusion/datafusion-37.0.0
We typically crowd source release announcements by collaborating on a Google document, usually starting with a copy of the previous release announcement.
Run the following commands to get the number of commits and number of unique contributors for inclusion in the blog post.
git log --pretty=oneline 37.0.0..38.0.0 datafusion datafusion-cli datafusion-examples | wc -l git shortlog -sn 37.0.0..38.0.0 datafusion datafusion-cli datafusion-examples | wc -l
Once there is consensus on the contents of the post, create a PR to add a blog post to the arrow-site repository. Note that there is no need for a formal PMC vote on the blog post contents since this isn't considered to be a “release”.
Here is an example blog post PR:
Once the PR is merged, a GitHub action will publish the new blog post to https://arrow.apache.org/blog/.