mirror of
https://github.com/apache/airflow.git
synced 2026-11-04 07:12:48 +00:00
Jason(Zhe-You) Liu
a419633896
* Java SDK: Rewrite the user docs around Dag definition Reorder the Java SDK guide to start from a Dag defined in Java, document conditions, switches and TriggerDagRun, and add a table of how stub task arguments bind. Split the README into a user landing page and DEVELOPMENT.md, and add an example README. * Add Logback and appender to the docs spelling wordlist * Address review: Dag-level queue, version sync, dropped constraints Set the queue once on the Dag in every example, now that a Java Dag takes one, and bump the documented version to 1.0.0-beta2 everywhere. Add a prek hook that fails when the guide, the README and the Dokka landing page name different versions. Restore the TaskInput constraints, correct the LocalExecutor wording, and drop the Python Label comparison. * Generate the quick start of the Java SDK README and Dokka page The quick start appears on three pages. The guide owns it now, between SHARED SNIPPET markers, and the sync-java-sdk-docs hook copies it into the other two and still checks that all three install the same version. * Address review: install a version placeholder, not a release The three pages that show how to install the SDK pinned a release that is not out yet, which also held the PR back. They now install `<version>` and link to Maven Central, and the sync hook fails when a page names a release instead. The parse-failure bullet leads with the SDK release a JAR was built with, and keeps the supervisor schema version as the explanation. ---------
124 lines
4.3 KiB
Bash
Executable File
124 lines
4.3 KiB
Bash
Executable File
#!/usr/bin/env 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.
|
|
|
|
# Run the reviewer checklist from java-sdk/DEVELOPMENT.md against an Apache Airflow
|
|
# Java SDK source-release tarball (except the GPG signature).
|
|
#
|
|
# Usage:
|
|
# verify-source-release.sh --tarball <path> --tag java-sdk/<version>-rc<N> \
|
|
# [--sha512 <path>]
|
|
#
|
|
# Requirements:
|
|
# Bash with common shell tools, Git, Gradle, JDK 11.
|
|
#
|
|
# Staged convenience binaries are checked separately by
|
|
# smoke-test-staged-binaries.sh (only meaningful for a staged release).
|
|
|
|
set -euo pipefail
|
|
|
|
REPO_ROOT="$(cd "$(dirname "$0")/../../.." && pwd)"
|
|
|
|
tarball="" tag="" sha512=""
|
|
while [ "$#" -gt 0 ]; do
|
|
case "$1" in
|
|
--tarball) tarball="$2"; shift 2 ;;
|
|
--tag) tag="$2"; shift 2 ;;
|
|
--sha512) sha512="$2"; shift 2 ;;
|
|
*) echo "Unknown argument: $1" >&2; exit 2 ;;
|
|
esac
|
|
done
|
|
if [ -z "$tarball" ] || [ -z "$tag" ]; then
|
|
echo "ERROR: --tarball and --tag are required" >&2
|
|
exit 2
|
|
fi
|
|
tarball="$(cd "$(dirname "$tarball")" && pwd)/$(basename "$tarball")"
|
|
[ -z "$sha512" ] || sha512="$(cd "$(dirname "$sha512")" && pwd)/$(basename "$sha512")"
|
|
|
|
work="$(mktemp -d)"
|
|
tagco="$work/tagco"
|
|
cleanup() {
|
|
git -C "$REPO_ROOT" worktree remove --force "$tagco" >/dev/null 2>&1 || true
|
|
rm -rf "$work"
|
|
}
|
|
trap cleanup EXIT
|
|
|
|
echo "==> 1. Checksum"
|
|
if [ -n "$sha512" ]; then
|
|
( cd "$(dirname "$tarball")" && sha512sum -c "$sha512" )
|
|
else
|
|
echo " no --sha512 given; skipping"
|
|
fi
|
|
|
|
echo "==> 2. Extract to a clean directory outside the repo"
|
|
tar -xzf "$tarball" -C "$work"
|
|
extracted="$(find "$work" -maxdepth 1 -type d -name 'apache-airflow-java-sdk-*' | head -n1)"
|
|
[ -n "$extracted" ] || { echo "ERROR: no apache-airflow-java-sdk-* directory inside the tarball" >&2; exit 1; }
|
|
echo " $extracted"
|
|
|
|
echo "==> 3. No compiled/binary files (ASF source releases must be source-only)"
|
|
bins="$(find "$extracted" -type f -exec sh -c 'file -b "$1" | grep -qviE "text|json|xml|empty" && echo "$1"' _ {} \; || true)"
|
|
if [ -n "$bins" ]; then
|
|
echo "ERROR: non-source files found in the tarball:" >&2
|
|
echo "$bins" >&2
|
|
exit 1
|
|
fi
|
|
echo " OK"
|
|
|
|
echo "==> 4. Diff against the tagged source (only export-ignored files may differ)"
|
|
git -C "$REPO_ROOT" worktree add --detach --quiet "$tagco" "$tag"
|
|
diffout="$(diff -rq "$extracted" "$tagco/java-sdk" \
|
|
| grep -vE ': (gradlew|gradlew\.bat|gradle-wrapper\.jar|scripts)$' || true)"
|
|
if [ -n "$diffout" ]; then
|
|
echo "ERROR: tarball differs from the tag beyond the export-ignored files:" >&2
|
|
echo "$diffout" >&2
|
|
exit 1
|
|
fi
|
|
echo " OK"
|
|
|
|
echo "==> 5. Build from scratch (regenerate the wrapper, then ./gradlew build)"
|
|
props="$extracted/gradle/wrapper/gradle-wrapper.properties"
|
|
gv="$(sed -n 's#^distributionUrl=.*/gradle-\(.*\)-bin\.zip#\1#p' "$props")"
|
|
gsum="$(sed -n 's#^distributionSha256Sum=##p' "$props")"
|
|
if [ -z "$gv" ] || [ -z "$gsum" ]; then
|
|
echo "ERROR: could not read Gradle version/sha256 from $props" >&2
|
|
exit 1
|
|
fi
|
|
(
|
|
cd "$extracted"
|
|
gradle --no-daemon wrapper --gradle-version "$gv" --gradle-distribution-sha256-sum "$gsum"
|
|
./gradlew --no-daemon build # `build` runs `check`, which runs :bom:verifyBomCoverage
|
|
)
|
|
echo " OK"
|
|
|
|
echo "==> 6. LICENSE and NOTICE present in every published jar"
|
|
repo="$work/maven-repo"
|
|
( cd "$extracted" && ./gradlew --no-daemon publish -PmavenUrl="file://$repo" -PskipSigning=true )
|
|
missing=0
|
|
while IFS= read -r jar; do
|
|
for entry in META-INF/LICENSE META-INF/NOTICE; do
|
|
if ! unzip -l "$jar" | grep -qE "${entry}$"; then
|
|
echo "ERROR: ${entry} missing from ${jar##*/}" >&2
|
|
missing=1
|
|
fi
|
|
done
|
|
done < <(find "$repo" -name '*.jar')
|
|
[ "$missing" -eq 0 ] || exit 1
|
|
echo " OK"
|
|
|
|
echo "All release-verification checks passed."
|