From 896b444f9202a10c1a1aabfaa414caf24f20329c Mon Sep 17 00:00:00 2001 From: Rodos Date: Thu, 11 Sep 2025 09:15:07 +1000 Subject: [PATCH] fix(docs): correct build optimization script and docs The build optimization script was removing the docs directory, which is a dependency of boto3. This change removes the line that removes the docs directory and adds a warning to the documentation to test the build after optimization. Fixes #7361 --- docs/build_recipes/performance-optimization.md | 2 ++ examples/build_recipes/build_optimization/optimize-advanced.sh | 1 - examples/build_recipes/build_optimization/optimize-package.sh | 3 +-- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/build_recipes/performance-optimization.md b/docs/build_recipes/performance-optimization.md index 22431999d47..fcea0d0eb0c 100644 --- a/docs/build_recipes/performance-optimization.md +++ b/docs/build_recipes/performance-optimization.md @@ -7,6 +7,8 @@ description: Optimize Lambda functions for better performance and reduced costs Optimize your Lambda functions for better performance, reduced cold start times, and lower costs. These techniques help minimize package size, improve startup speed, and reduce memory usage. +Always validate your function's behavior after applying optimizations to ensure an optimization hasn't introduced any issues with your packages. For example, removal of directories that appear to be unnecessary, such as `docs`, can break some libraries. + ## Reduce cold start times 1. **Minimize package size** by excluding unnecessary files diff --git a/examples/build_recipes/build_optimization/optimize-advanced.sh b/examples/build_recipes/build_optimization/optimize-advanced.sh index b27b466166f..eb389820dc4 100644 --- a/examples/build_recipes/build_optimization/optimize-advanced.sh +++ b/examples/build_recipes/build_optimization/optimize-advanced.sh @@ -15,7 +15,6 @@ find build/ -name "*.so.*" -exec strip --strip-debug {} \; 2>/dev/null || true rm -rf build/*/site-packages/*/tests/ rm -rf build/*/site-packages/*/test/ rm -rf build/*/site-packages/*/.git/ -rm -rf build/*/site-packages/*/docs/ rm -rf build/*/site-packages/*/examples/ rm -rf build/*/site-packages/*/*.md rm -rf build/*/site-packages/*/*.rst diff --git a/examples/build_recipes/build_optimization/optimize-package.sh b/examples/build_recipes/build_optimization/optimize-package.sh index d0521c3f532..c06af942289 100644 --- a/examples/build_recipes/build_optimization/optimize-package.sh +++ b/examples/build_recipes/build_optimization/optimize-package.sh @@ -7,8 +7,7 @@ find build/ -name "*.dist-info" -type d -exec rm -rf {} + find build/ -name "tests" -type d -exec rm -rf {} + find build/ -name "test_*" -delete -# Remove documentation and examples -find build/ -name "docs" -type d -exec rm -rf {} + +# Remove examples find build/ -name "examples" -type d -exec rm -rf {} + echo "✅ Package optimized"