From 7a1a23d5f50cd113613cf54ee5346f0e83d1edc4 Mon Sep 17 00:00:00 2001 From: Andy Grove Date: Mon, 12 Aug 2024 15:57:40 -0600 Subject: [PATCH] minor: Update release documentation based on 41.0.0 release (#11947) * fix release issues * remove out of date dependency diagram --- datafusion/catalog/Cargo.toml | 1 + dev/release/README.md | 17 +- dev/release/crate-deps.dot | 91 ------- dev/release/crate-deps.svg | 445 ---------------------------------- dev/release/release-crates.sh | 45 ---- 5 files changed, 4 insertions(+), 595 deletions(-) delete mode 100644 dev/release/crate-deps.dot delete mode 100644 dev/release/crate-deps.svg delete mode 100644 dev/release/release-crates.sh diff --git a/datafusion/catalog/Cargo.toml b/datafusion/catalog/Cargo.toml index 2ebca511c5c8..ff28d8e0c64a 100644 --- a/datafusion/catalog/Cargo.toml +++ b/datafusion/catalog/Cargo.toml @@ -17,6 +17,7 @@ [package] name = "datafusion-catalog" +description = "datafusion-catalog" authors.workspace = true edition.workspace = true homepage.workspace = true diff --git a/dev/release/README.md b/dev/release/README.md index 1817b3002578..397369a41aa3 100644 --- a/dev/release/README.md +++ b/dev/release/README.md @@ -256,20 +256,7 @@ 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. - -![](crate-deps.svg) - -_To update this diagram, manually edit the dependencies in [crate-deps.dot](crate-deps.dot) and then run:_ - -```shell -dot -Tsvg dev/release/crate-deps.dot > dev/release/crate-deps.svg -``` +(e.g. `version = "38.0.0"`) and then publish the crates by running the following commands ```shell (cd datafusion/common && cargo publish) @@ -283,7 +270,9 @@ dot -Tsvg dev/release/crate-deps.dot > dev/release/crate-deps.svg (cd datafusion/sql && cargo publish) (cd datafusion/optimizer && cargo publish) (cd datafusion/common-runtime && cargo publish) +(cd datafusion/catalog && cargo publish) (cd datafusion/physical-plan && cargo publish) +(cd datafusion/physical-optimizer && cargo publish) (cd datafusion/core && cargo publish) (cd datafusion/proto-common && cargo publish) (cd datafusion/proto && cargo publish) diff --git a/dev/release/crate-deps.dot b/dev/release/crate-deps.dot deleted file mode 100644 index 1d903a56021d..000000000000 --- a/dev/release/crate-deps.dot +++ /dev/null @@ -1,91 +0,0 @@ -// 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. - -digraph G { - datafusion_examples - datafusion_examples -> datafusion - datafusion_examples -> datafusion_common - datafusion_examples -> datafusion_expr - datafusion_examples -> datafusion_optimizer - datafusion_examples -> datafusion_physical_expr - datafusion_examples -> datafusion_sql - datafusion_expr - datafusion_expr -> datafusion_common - datafusion_functions - datafusion_functions -> datafusion_common - datafusion_functions -> datafusion_execution - datafusion_functions -> datafusion_expr - datafusion_wasmtest - datafusion_wasmtest -> datafusion - datafusion_wasmtest -> datafusion_common - datafusion_wasmtest -> datafusion_execution - datafusion_wasmtest -> datafusion_expr - datafusion_wasmtest -> datafusion_optimizer - datafusion_wasmtest -> datafusion_physical_expr - datafusion_wasmtest -> datafusion_physical_plan - datafusion_wasmtest -> datafusion_sql - datafusion_common - datafusion_sql - datafusion_sql -> datafusion_common - datafusion_sql -> datafusion_expr - datafusion_physical_plan - datafusion_physical_plan -> datafusion_common - datafusion_physical_plan -> datafusion_execution - datafusion_physical_plan -> datafusion_expr - datafusion_physical_plan -> datafusion_physical_expr - datafusion_benchmarks - datafusion_benchmarks -> datafusion - datafusion_benchmarks -> datafusion_common - datafusion_benchmarks -> datafusion_proto - datafusion_docs_tests - datafusion_docs_tests -> datafusion - datafusion_optimizer - datafusion_optimizer -> datafusion_common - datafusion_optimizer -> datafusion_expr - datafusion_optimizer -> datafusion_physical_expr - datafusion_optimizer -> datafusion_sql - datafusion_proto - datafusion_proto -> datafusion - datafusion_proto -> datafusion_common - datafusion_proto -> datafusion_expr - datafusion_physical_expr - datafusion_physical_expr -> datafusion_common - datafusion_physical_expr -> datafusion_execution - datafusion_physical_expr -> datafusion_expr - datafusion_sqllogictest - datafusion_sqllogictest -> datafusion - datafusion_sqllogictest -> datafusion_common - datafusion - datafusion -> datafusion_common - datafusion -> datafusion_execution - datafusion -> datafusion_expr - datafusion -> datafusion_functions - datafusion -> datafusion_functions_nested - datafusion -> datafusion_optimizer - datafusion -> datafusion_physical_expr - datafusion -> datafusion_physical_plan - datafusion -> datafusion_sql - datafusion_functions_nested - datafusion_functions_nested -> datafusion_common - datafusion_functions_nested -> datafusion_execution - datafusion_functions_nested -> datafusion_expr - datafusion_execution - datafusion_execution -> datafusion_common - datafusion_execution -> datafusion_expr - datafusion_substrait - datafusion_substrait -> datafusion -} \ No newline at end of file diff --git a/dev/release/crate-deps.svg b/dev/release/crate-deps.svg deleted file mode 100644 index c76fe3abb4ac..000000000000 --- a/dev/release/crate-deps.svg +++ /dev/null @@ -1,445 +0,0 @@ - - - - - - -G - - - -datafusion_examples - -datafusion_examples - - - -datafusion - -datafusion - - - -datafusion_examples->datafusion - - - - - -datafusion_common - -datafusion_common - - - -datafusion_examples->datafusion_common - - - - - -datafusion_expr - -datafusion_expr - - - -datafusion_examples->datafusion_expr - - - - - -datafusion_optimizer - -datafusion_optimizer - - - -datafusion_examples->datafusion_optimizer - - - - - -datafusion_physical_expr - -datafusion_physical_expr - - - -datafusion_examples->datafusion_physical_expr - - - - - -datafusion_sql - -datafusion_sql - - - -datafusion_examples->datafusion_sql - - - - - -datafusion->datafusion_common - - - - - -datafusion->datafusion_expr - - - - - -datafusion->datafusion_optimizer - - - - - -datafusion->datafusion_physical_expr - - - - - -datafusion->datafusion_sql - - - - - -datafusion_functions - -datafusion_functions - - - -datafusion->datafusion_functions - - - - - -datafusion_execution - -datafusion_execution - - - -datafusion->datafusion_execution - - - - - -datafusion_physical_plan - -datafusion_physical_plan - - - -datafusion->datafusion_physical_plan - - - - - -datafusion_functions_nested - -datafusion_functions_nested - - - -datafusion->datafusion_functions_nested - - - - - -datafusion_expr->datafusion_common - - - - - -datafusion_optimizer->datafusion_common - - - - - -datafusion_optimizer->datafusion_expr - - - - - -datafusion_optimizer->datafusion_physical_expr - - - - - -datafusion_optimizer->datafusion_sql - - - - - -datafusion_physical_expr->datafusion_common - - - - - -datafusion_physical_expr->datafusion_expr - - - - - -datafusion_physical_expr->datafusion_execution - - - - - -datafusion_sql->datafusion_common - - - - - -datafusion_sql->datafusion_expr - - - - - -datafusion_functions->datafusion_common - - - - - -datafusion_functions->datafusion_expr - - - - - -datafusion_functions->datafusion_execution - - - - - -datafusion_execution->datafusion_common - - - - - -datafusion_execution->datafusion_expr - - - - - -datafusion_wasmtest - -datafusion_wasmtest - - - -datafusion_wasmtest->datafusion - - - - - -datafusion_wasmtest->datafusion_common - - - - - -datafusion_wasmtest->datafusion_expr - - - - - -datafusion_wasmtest->datafusion_optimizer - - - - - -datafusion_wasmtest->datafusion_physical_expr - - - - - -datafusion_wasmtest->datafusion_sql - - - - - -datafusion_wasmtest->datafusion_execution - - - - - -datafusion_wasmtest->datafusion_physical_plan - - - - - -datafusion_physical_plan->datafusion_common - - - - - -datafusion_physical_plan->datafusion_expr - - - - - -datafusion_physical_plan->datafusion_physical_expr - - - - - -datafusion_physical_plan->datafusion_execution - - - - - -datafusion_benchmarks - -datafusion_benchmarks - - - -datafusion_benchmarks->datafusion - - - - - -datafusion_benchmarks->datafusion_common - - - - - -datafusion_proto - -datafusion_proto - - - -datafusion_benchmarks->datafusion_proto - - - - - -datafusion_proto->datafusion - - - - - -datafusion_proto->datafusion_common - - - - - -datafusion_proto->datafusion_expr - - - - - -datafusion_docs_tests - -datafusion_docs_tests - - - -datafusion_docs_tests->datafusion - - - - - -datafusion_sqllogictest - -datafusion_sqllogictest - - - -datafusion_sqllogictest->datafusion - - - - - -datafusion_sqllogictest->datafusion_common - - - - - -datafusion_functions_nested->datafusion_common - - - - - -datafusion_functions_nested->datafusion_expr - - - - - -datafusion_functions_nested->datafusion_execution - - - - - -datafusion_substrait - -datafusion_substrait - - - -datafusion_substrait->datafusion - - - - - diff --git a/dev/release/release-crates.sh b/dev/release/release-crates.sh deleted file mode 100644 index b9bda68b780b..000000000000 --- a/dev/release/release-crates.sh +++ /dev/null @@ -1,45 +0,0 @@ -#!/bin/bash -# -# 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. -# - -# This script publishes datafusion crates to crates.io. -# -# This script should only be run after the release has been approved -# by the Apache DataFusion PMC committee. -# -# See release/README.md for full release instructions - -set -eu - -# Do not run inside a git repo -if ! [ git rev-parse --is-inside-work-tree ]; then - cd datafusion/common && cargo publish - cd datafusion/expr && cargo publish - cd datafusion/sql && cargo publish - cd datafusion/physical-expr && cargo publish - cd datafusion/optimizer && cargo publish - cd datafusion/core && cargo publish - cd datafusion/proto && cargo publish - cd datafusion/execution && cargo publish - cd datafusion/substrait && cargo publish - cd datafusion-cli && cargo publish --no-verify -else - echo "Crates must be released from the source tarball that was voted on, not from the repo" - exit 1 -fi