samredai commented on a change in pull request #3479: URL: https://github.com/apache/iceberg/pull/3479#discussion_r753384277
########## File path: site/docs/how-to-verify-a-release.md ########## @@ -0,0 +1,149 @@ +<!-- + - 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. + --> + +# The Release Candidate + +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)** +- **Key files** +- **GitHub change comparison** + +After downloading the source tarball, signature, checksum, and key files, here are instructions on how to +verify signatures, checksums, and documentation. + +### Verifying Signatures + +First, import the keys. +```bash +gpg --import ${PATH_TO_KEY_FILES} +``` + +Next, verify the `.asc` file. +```bash +gpg --verify apache-iceberg-${VERSION}.tar.gz.asc +``` + +### Verifying Checksums + +```bash +shasum -a 512 apache-iceberg-${VERSION}.tar.gz.sha512 +``` + +### Verifying License Documentation + +Untar the archive and change into the source directory. +```bash +tar xzf apache-iceberg-${VERSION}.tar.gz +cd apache-iceberg-${VERSION} +``` + +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: +```bash +spark-shell \ + --conf spark.jars.repositories=${MAVEN_URL} \ + --packages org.apache.iceberg:iceberg-spark3-runtime:${ICEBERG_VERSION} \ + --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/${ICEBERG_VERSION}/iceberg-flink-runtime-${ICEBERG_VERSION}.jar + +sql-client.sh embedded \ + -j iceberg-flink-runtime-${ICEBERG_VERSION}.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 Review comment: Fixed! -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
