Build applications that make decisions (chatbots, agents, simulations, etc...). Monitor, trace, persist, and execute on your own infrastructure.
Python aiburrchatbot-frameworkdagsgenerative-aigraphshacktoberfestllmopsllmsmlopspersistent-data-structurestate-machinestate-managementvisibility
Script fixes for release (#628)
Elijah ben Izzy5446cdb6471f
diff --git a/burr/cli/__main__.py b/burr/cli/__main__.pyindex 109eb835..aeb56f7d 100644--- a/burr/cli/__main__.py+++ b/burr/cli/__main__.py@@ -132,7 +132,8 @@ def cli():pass-def _build_ui():+def run_build_ui_bash_commands():+ """Execute the bash commands to build UI artifacts."""cmd = "npm install --prefix telemetry/ui"_command(cmd, capture_output=False)cmd = "npm run build --prefix telemetry/ui"@@ -146,12 +147,13 @@ def _build_ui():_command(cmd, capture_output=False)[email protected](name="build-ui")def build_ui():+ """Build the UI artifacts from source."""git_root = _get_git_root()logger.info("UI build: using project root %s", git_root)with cd(git_root):- _build_ui()+ run_build_ui_bash_commands()BACKEND_MODULES = {@@ -246,7 +248,7 @@ def build_and_publish(prod: bool, no_wipe_dist: bool):git_root = _get_git_root()with cd(git_root):logger.info("Building UI -- this may take a bit...")- _build_ui()+ build_ui()logger.info("Built UI!")if not no_wipe_dist:logger.info("Wiping dist/ directory for a clean publish.")diff --git a/docs/_templates/page.html b/docs/_templates/page.htmlindex 8ac03996..b7dfa780 100644--- a/docs/_templates/page.html+++ b/docs/_templates/page.html@@ -1,3 +1,22 @@+<!--+ 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.+-->+{% extends "!page.html" %}{% block extrahead %}diff --git a/scripts/README.md b/scripts/README.mdindex 92393c9b..6d96a1a7 100644--- a/scripts/README.md+++ b/scripts/README.md@@ -99,6 +99,36 @@ python scripts/apache_release.py all 0.41.0 0 your_apache_id --no-uploadOutput: `dist/` directory with tar.gz (archive + sdist), whl, plus .asc and .sha512 files. Install from the whl file to test it out after runnig the `wheel` subcommand.+## For Voters: Verifying a Release++If you're voting on a release, follow these steps to verify the release candidate:++### Quick Start++```bash+# 1. Download and extract the source archive+wget https://dist.apache.org/repos/dist/dev/incubator/burr/{VERSION}-incubating-RC{N}/apache-burr-{VERSION}-incubating.tar.gz+tar -xzf apache-burr-{VERSION}-incubating.tar.gz+cd apache-burr-{VERSION}-incubating/++# 2. Verify signatures and checksums+python scripts/verify_apache_artifacts.py signatures++# 3. Install build dependencies+pip install flit++# 4. Build the wheel from source+python scripts/apache_release.py wheel {VERSION} {RC_NUM}++# 5. Install and run the wheel+pip install "dist/apache_burr-{VERSION}-py3-none-any.whl[learn]"+burr+```++You can run tests, etc... from here++See the "Verification" section below for more detailed verification steps.+## VerificationValidate artifacts before uploading or voting. Checks GPG signatures, SHA512 checksums, archive integrity, and license compliance with Apache RAT. The `list-contents` command is useful for inspecting what's actually packaged in each artifact.diff --git a/scripts/apache_release.py b/scripts/apache_release.pyindex 4edba961..d4c28afc 100644--- a/scripts/apache_release.py+++ b/scripts/apache_release.py@@ -79,6 +79,46 @@ def _print_step(step_num: int, total: int, description: str) -> None:print("-" * 80)+def _run_command(+ cmd: list[str],+ description: str,+ error_message: str,+ success_message: Optional[str] = None,+ capture_output: bool = True,+ **kwargs,+) -> subprocess.CompletedProcess:+ """Run a subprocess command with consistent error handling and output.++ Args:+ cmd: Command and arguments as list+ description: What we're doing (printed before running)+ error_message: Error message prefix if command fails+ success_message: Optional success message (printed after if provided)+ capture_output: Whether to capture stdout/stderr (default True)+ **kwargs: Additional arguments to pass to subprocess.run++ Returns:+ CompletedProcess instance+ """+ if description:+ print(f" {description}")++ try:+ result = subprocess.run(+ cmd,+ check=True,+ capture_output=capture_output,+ text=True,+ **kwargs,+ )+ if success_message:+ print(f" ✓ {success_message}")+ return result+ except subprocess.CalledProcessError as e:+ error_detail = f": {e.stderr}" if capture_output and e.stderr else ""+ _fail(f"{error_message}{error_detail}")++# ============================================================================# Environment Validation# ============================================================================@@ -200,14 +240,13 @@ def _sign_artifact(artifact_path: str) -> tuple[str, str]:checksum_path = f"{artifact_path}.sha512"# GPG signature- try:- subprocess.run(- ["gpg", "--armor", "--output", signature_path, "--detach-sig", artifact_path],- check=True,- )- print(f" ✓ Created GPG signature: {signature_path}")- except subprocess.CalledProcessError as e:- _fail(f"Error signing artifact: {e}")+ _run_command(+ ["gpg", "--armor", "--output", signature_path, "--detach-sig", artifact_path],+ description="",+ error_message="Error signing artifact",+ capture_output=False,+ )+ print(f" ✓ Created GPG signature: {signature_path}")# SHA512 checksumsha512_hash = hashlib.sha512()@@ -306,22 +345,21 @@ def _create_git_archive(version: str, rc_num: str, output_dir: str = "dist") ->archive_path = os.path.join(output_dir, archive_name)prefix = f"apache-burr-{version}-incubating/"- try:- subprocess.run(- [- "git",- "archive",- "HEAD",- f"--prefix={prefix}",- "--format=tar.gz",- "--output",- archive_path,- ],- check=True,- )- print(f" ✓ Created git archive: {archive_path}")- except subprocess.CalledProcessError as e:- _fail(f"Error creating git archive: {e}")+ _run_command(+ [+ "git",+ "archive",+ "HEAD",+ f"--prefix={prefix}",+ "--format=tar.gz",+ "--output",+ archive_path,+ ],+ description="",+ error_message="Error creating git archive",+ capture_output=False,+ )+ print(f" ✓ Created git archive: {archive_path}")file_size = os.path.getsize(archive_path)print(f" ✓ Archive size: {file_size:,} bytes")@@ -359,20 +397,15 @@ def _build_sdist_from_git(version: str, output_dir: str = "dist") -> str:_remove_ui_build_artifacts()_check_git_working_tree()- print(" Running flit build --format sdist...")- try:- env = os.environ.copy()- env["FLIT_USE_VCS"] = "0"- subprocess.run(- ["flit", "build", "--format", "sdist"],- env=env,- capture_output=True,- text=True,- check=True,- )- print(" ✓ flit sdist created successfully")- except subprocess.CalledProcessError as e:- _fail(f"Failed to build sdist: {e.stderr}")+ env = os.environ.copy()+ env["FLIT_USE_VCS"] = "0"+ _run_command(+ ["flit", "build", "--format", "sdist"],+ description="Running flit build --format sdist...",+ error_message="Failed to build sdist",+ success_message="flit sdist created successfully",+ env=env,+ )# Find and rename sdistexpected_pattern = f"dist/apache_burr-{version.lower()}.tar.gz"@@ -401,28 +434,46 @@ def _build_sdist_from_git(version: str, output_dir: str = "dist") -> str:def _build_ui_artifacts() -> None:- """Build UI artifacts using burr-admin-build-ui."""+ """Build UI artifacts (npm build + copy to burr/tracking/server/build).++ This replicates the logic from burr.cli.__main__.run_build_ui_bash_commands()+ without requiring burr to be installed.+ """print("Building UI artifacts...")+ ui_source_dir = "telemetry/ui"ui_build_dir = "burr/tracking/server/build"# Clean existing UI buildif os.path.exists(ui_build_dir):shutil.rmtree(ui_build_dir)- # Check for burr-admin-build-ui- if shutil.which("burr-admin-build-ui") is None:- _fail("burr-admin-build-ui not found. Install with: pip install -e .[cli]")+ # Install npm dependencies+ _run_command(+ ["npm", "install", "--prefix", ui_source_dir],+ description="Installing npm dependencies...",+ error_message="npm install failed",+ success_message="npm dependencies installed",+ )++ # Build UI with npm+ _run_command(+ ["npm", "run", "build", "--prefix", ui_source_dir],+ description="Building UI with npm...",+ error_message="npm build failed",+ success_message="npm build completed",+ )- # Build UI- env = os.environ.copy()- env["BURR_PROJECT_ROOT"] = os.getcwd()+ # Copy build artifacts+ print(" Copying build artifacts...")+ os.makedirs(ui_build_dir, exist_ok=True)+ ui_output = os.path.join(ui_source_dir, "build")try:- subprocess.run(["burr-admin-build-ui"], check=True, env=env, capture_output=True)- print(" ✓ UI artifacts built successfully")- except subprocess.CalledProcessError as e:- _fail(f"Error building UI: {e}")+ shutil.copytree(ui_output, ui_build_dir, dirs_exist_ok=True)+ print(" ✓ Build artifacts copied")+ except Exception as e:+ _fail(f"Failed to copy build artifacts: {e}")# Verifyif not os.path.exists(ui_build_dir) or not os.listdir(ui_build_dir):@@ -505,13 +556,13 @@ def _build_wheel_from_current_dir(version: str, output_dir: str = "dist") -> strenv = os.environ.copy()env["FLIT_USE_VCS"] = "0"- subprocess.run(+ _run_command(["flit", "build", "--format", "wheel"],+ description="",+ error_message="Wheel build failed",+ success_message="Wheel built successfully",env=env,- check=True,- capture_output=True,)- print(" ✓ Wheel built successfully")# Find the wheelwheel_pattern = f"dist/apache_burr-{version}*.whl"@@ -525,8 +576,6 @@ def _build_wheel_from_current_dir(version: str, output_dir: str = "dist") -> strreturn wheel_path- except subprocess.CalledProcessError as e:- _fail(f"Wheel build failed: {e}")finally:# Always restore symlinksif copied:@@ -662,18 +711,14 @@ The artifacts for this release candidate can be found at:The Git tag to be voted upon is:{tag}-Release artifacts are signed with your GPG key. The KEYS file is available at:+Release artifacts are signed with the release manager's GPG key. The KEYS file is available at:https://downloads.apache.org/incubator/{PROJECT_SHORT_NAME}/KEYSPlease download, verify, and test the release candidate.-Some ideas to verify the release:-1. Build from source - see README in scripts/ directory for instructions-2. Install the wheel using pip to test functionality-3. Run license verification using the verify_apache_artifacts.py script or manually check- - Verify checksums and signatures match- - Check LICENSE/NOTICE files are present- - Ensure all source files have Apache headers+For detailed step-by-step instructions on how to verify this release, please see the+"For Voters: Verifying a Release" section in the scripts/README.md file within the+source archive.The vote will run for a minimum of 72 hours.Please vote: