fix(docs): correct build optimization script and docs #7367
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 aws-powertools#7361
pull-request-size
bot
added
the
size/XS
boring-cyborg
bot
added
the
documentation
|
Thanks a lot for your first contribution! Please check out our contributing guidelines and don't hesitate to ask whatever you need. |
|
github-actions
bot
added
bug
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #7367 +/- ##
========================================
Coverage 96.36% 96.36%
========================================
Files 275 275
Lines 13027 13027
Branches 970 970
========================================
Hits 12554 12554
Misses 366 366
Partials 107 107 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
leandrodamascena
approved these changes
Sep 11, 2025
|
Awesome work, congrats on your first merged pull request and thank you for helping improve everyone's experience! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue number: closes #7361
Summary
The build optimization script was removing the docs directory, which is a dependency of boto3.
Changes
This change removes the line that removes the docs directory and adds a warning to the documentation to test the build after optimization.
User experience
A copy and paste of the example will no longer break a vendored version of boto3. The prompt that removing directories may have side effects may direct some to perform a test when they may otherwise not, avoiding issues .
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.