You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iceberg.apache.org by dw...@apache.org on 2022/07/01 15:18:46 UTC
[iceberg-docs] branch main updated: Move how-to-verify-a-release section under how-to-release.md
This is an automated email from the ASF dual-hosted git repository.
dweeks pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/iceberg-docs.git
The following commit(s) were added to refs/heads/main by this push:
new ad6414b8 Move how-to-verify-a-release section under how-to-release.md
new 6ba52e0d Merge pull request #107 from nastra/how-to-verify-release-project-dropdown
ad6414b8 is described below
commit ad6414b8a0a96d0e5aeb1463583a91e0e01461b8
Author: Eduard Tudenhoefner <et...@gmail.com>
AuthorDate: Thu Jun 30 09:00:05 2022 +0200
Move how-to-verify-a-release section under how-to-release.md
---
landing-page/content/common/how-to-release.md | 137 ++++++++++++++++++
.../content/common/how-to-verify-a-release.md | 157 ---------------------
2 files changed, 137 insertions(+), 157 deletions(-)
diff --git a/landing-page/content/common/how-to-release.md b/landing-page/content/common/how-to-release.md
index b3af9155..34f2b14b 100644
--- a/landing-page/content/common/how-to-release.md
+++ b/landing-page/content/common/how-to-release.md
@@ -337,3 +337,140 @@ A PR needs to be published in the `iceberg-docs` repository with the following c
2. Update variable `latestVersions.iceberg` to the new release version in `docs/config.toml`
3. Mark the current latest release notes to past releases under `landing-page/content/common/release-notes.md`
4. Add release notes for the new release version in `landing-page/content/common/release-notes.md`
+
+
+# How to Verify a Release
+
+Each Apache Iceberg release is validated by the community by holding a vote. A community release manager
+will prepare a release candidate and call a vote on the Iceberg
+[dev list](https://iceberg.apache.org/#community/#mailing-lists).
+To validate the release candidate, community members will test it out in their downstream projects and environments.
+It's recommended to report the Java, Scala, Spark, Flink and Hive versions you have tested against when you vote.
+
+In addition to testing in downstream projects, community members also check the release's signatures, checksums, and
+license documentation.
+
+## Validating a source release candidate
+
+Release announcements include links to the following:
+
+- **A source tarball**
+- **A signature (.asc)**
+- **A checksum (.sha512)**
+- **KEYS file**
+- **GitHub change comparison**
+
+After downloading the source tarball, signature, checksum, and KEYS file, here are instructions on how to
+verify signatures, checksums, and documentation.
+
+### Verifying Signatures
+
+First, import the keys.
+```bash
+curl https://dist.apache.org/repos/dist/dev/iceberg/KEYS -o KEYS
+gpg --import KEYS
+```
+
+Next, verify the `.asc` file.
+```bash
+gpg --verify apache-iceberg-{{% icebergVersion %}}.tar.gz.asc
+```
+
+### Verifying Checksums
+
+```bash
+shasum -a 512 --check apache-iceberg-{{% icebergVersion %}}.tar.gz.sha512
+```
+
+### Verifying License Documentation
+
+Untar the archive and change into the source directory.
+```bash
+tar xzf apache-iceberg-{{% icebergVersion %}}.tar.gz
+cd apache-iceberg-{{% icebergVersion %}}
+```
+
+Run RAT checks to validate license headers.
+```bash
+dev/check-license
+```
+
+### Verifying Build and Test
+
+To verify that the release candidate builds properly, run the following command.
+```bash
+./gradlew build
+```
+
+## Testing release binaries
+
+Release announcements will also include a maven repository location. You can use this
+location to test downstream dependencies by adding it to your maven or gradle build.
+
+To use the release in your maven build, add the following to your `POM` or `settings.xml`:
+```xml
+...
+ <repositories>
+ <repository>
+ <id>iceberg-release-candidate</id>
+ <name>Iceberg Release Candidate</name>
+ <url>${MAVEN_URL}</url>
+ </repository>
+ </repositories>
+...
+```
+
+To use the release in your gradle build, add the following to your `build.gradle`:
+```groovy
+repositories {
+ mavenCentral()
+ maven {
+ url "${MAVEN_URL}"
+ }
+}
+```
+
+!!! Note
+Replace `${MAVEN_URL}` with the URL provided in the release announcement
+
+### Verifying with Spark
+
+To verify using spark, start a `spark-shell` with a command like the following command (use the appropriate
+spark-runtime jar for the Spark installation):
+```bash
+spark-shell \
+ --conf spark.jars.repositories=${MAVEN_URL} \
+ --packages org.apache.iceberg:iceberg-spark3-runtime:{{% icebergVersion %}} \
+ --conf spark.sql.extensions=org.apache.iceberg.spark.extensions.IcebergSparkSessionExtensions \
+ --conf spark.sql.catalog.local=org.apache.iceberg.spark.SparkCatalog \
+ --conf spark.sql.catalog.local.type=hadoop \
+ --conf spark.sql.catalog.local.warehouse=${LOCAL_WAREHOUSE_PATH} \
+ --conf spark.sql.catalog.local.default-namespace=default \
+ --conf spark.sql.defaultCatalog=local
+```
+
+### Verifying with Flink
+
+To verify using Flink, start a Flink SQL Client with the following command:
+```bash
+wget ${MAVEN_URL}/iceberg-flink-runtime/{{% icebergVersion %}}/iceberg-flink-runtime-{{% icebergVersion %}}.jar
+
+sql-client.sh embedded \
+ -j iceberg-flink-runtime-{{% icebergVersion %}}.jar \
+ -j ${FLINK_CONNECTOR_PACKAGE}-${HIVE_VERSION}_${SCALA_VERSION}-${FLINK_VERSION}.jar \
+ shell
+```
+
+## Voting
+
+Votes are cast by replying to the release candidate announcement email on the dev mailing list
+with either `+1`, `0`, or `-1`.
+
+> [ ] +1 Release this as Apache Iceberg {{% icebergVersion %}}
+[ ] +0
+[ ] -1 Do not release this because...
+
+In addition to your vote, it's customary to specify if your vote is binding or non-binding. Only members
+of the Project Management Committee have formally binding votes. If you're unsure, you can specify that your
+vote is non-binding. To read more about voting in the Apache framework, checkout the
+[Voting](https://www.apache.org/foundation/voting.html) information page on the Apache foundation's website.
\ No newline at end of file
diff --git a/landing-page/content/common/how-to-verify-a-release.md b/landing-page/content/common/how-to-verify-a-release.md
deleted file mode 100644
index 4d877f4b..00000000
--- a/landing-page/content/common/how-to-verify-a-release.md
+++ /dev/null
@@ -1,157 +0,0 @@
----
-title: How to Verify a Release
-url: how-to-verify-a-release
-disableSidebar: true
----
-<!--
- - 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.
- -->
-
-# How to Verify a Release
-
-Each Apache Iceberg release is validated by the community by holding a vote. A community release manager
-will prepare a release candidate and call a vote on the Iceberg
-[dev list](https://iceberg.apache.org/#community/#mailing-lists).
-To validate the release candidate, community members will test it out in their downstream projects and environments.
-It's recommended to report the Java, Scala, Spark, Flink and Hive versions you have tested against when you vote.
-
-In addition to testing in downstream projects, community members also check the release's signatures, checksums, and
-license documentation.
-
-## Validating a source release candidate
-
-Release announcements include links to the following:
-
-- **A source tarball**
-- **A signature (.asc)**
-- **A checksum (.sha512)**
-- **KEYS file**
-- **GitHub change comparison**
-
-After downloading the source tarball, signature, checksum, and KEYS file, here are instructions on how to
-verify signatures, checksums, and documentation.
-
-### Verifying Signatures
-
-First, import the keys.
-```bash
-curl https://dist.apache.org/repos/dist/dev/iceberg/KEYS -o KEYS
-gpg --import KEYS
-```
-
-Next, verify the `.asc` file.
-```bash
-gpg --verify apache-iceberg-{{% icebergVersion %}}.tar.gz.asc
-```
-
-### Verifying Checksums
-
-```bash
-shasum -a 512 --check apache-iceberg-{{% icebergVersion %}}.tar.gz.sha512
-```
-
-### Verifying License Documentation
-
-Untar the archive and change into the source directory.
-```bash
-tar xzf apache-iceberg-{{% icebergVersion %}}.tar.gz
-cd apache-iceberg-{{% icebergVersion %}}
-```
-
-Run RAT checks to validate license headers.
-```bash
-dev/check-license
-```
-
-### Verifying Build and Test
-
-To verify that the release candidate builds properly, run the following command.
-```bash
-./gradlew build
-```
-
-## Testing release binaries
-
-Release announcements will also include a maven repository location. You can use this
-location to test downstream dependencies by adding it to your maven or gradle build.
-
-To use the release in your maven build, add the following to your `POM` or `settings.xml`:
-```xml
-...
- <repositories>
- <repository>
- <id>iceberg-release-candidate</id>
- <name>Iceberg Release Candidate</name>
- <url>${MAVEN_URL}</url>
- </repository>
- </repositories>
-...
-```
-
-To use the release in your gradle build, add the following to your `build.gradle`:
-```groovy
-repositories {
- mavenCentral()
- maven {
- url "${MAVEN_URL}"
- }
-}
-```
-
-!!! Note
- Replace `${MAVEN_URL}` with the URL provided in the release announcement
-
-### Verifying with Spark
-
-To verify using spark, start a `spark-shell` with a command like the following command (use the appropriate
-spark-runtime jar for the Spark installation):
-```bash
-spark-shell \
- --conf spark.jars.repositories=${MAVEN_URL} \
- --packages org.apache.iceberg:iceberg-spark3-runtime:{{% icebergVersion %}} \
- --conf spark.sql.extensions=org.apache.iceberg.spark.extensions.IcebergSparkSessionExtensions \
- --conf spark.sql.catalog.local=org.apache.iceberg.spark.SparkCatalog \
- --conf spark.sql.catalog.local.type=hadoop \
- --conf spark.sql.catalog.local.warehouse=${LOCAL_WAREHOUSE_PATH} \
- --conf spark.sql.catalog.local.default-namespace=default \
- --conf spark.sql.defaultCatalog=local
-```
-
-### Verifying with Flink
-
-To verify using Flink, start a Flink SQL Client with the following command:
-```bash
-wget ${MAVEN_URL}/iceberg-flink-runtime/{{% icebergVersion %}}/iceberg-flink-runtime-{{% icebergVersion %}}.jar
-
-sql-client.sh embedded \
- -j iceberg-flink-runtime-{{% icebergVersion %}}.jar \
- -j ${FLINK_CONNECTOR_PACKAGE}-${HIVE_VERSION}_${SCALA_VERSION}-${FLINK_VERSION}.jar \
- shell
-```
-
-## Voting
-
-Votes are cast by replying to the release candidate announcement email on the dev mailing list
-with either `+1`, `0`, or `-1`.
-
-> [ ] +1 Release this as Apache Iceberg {{% icebergVersion %}}
-[ ] +0
-[ ] -1 Do not release this because...
-
-In addition to your vote, it's customary to specify if your vote is binding or non-binding. Only members
-of the Project Management Committee have formally binding votes. If you're unsure, you can specify that your
-vote is non-binding. To read more about voting in the Apache framework, checkout the
-[Voting](https://www.apache.org/foundation/voting.html) information page on the Apache foundation's website.