Add python docs package update script - #314
Open
davidhorstmann-arm wants to merge 5 commits into
Open
Conversation
This installs pip-tools and runs pip-compile on docs/requirements.in to regenerate docs/requirements.txt with the latest versions of things. Note: This script was originally created in the Mbed TLS repository and will need rework to fit in the framework. Signed-off-by: David Horstmann <david.horstmann@arm.com>
Ensure the script is being run from the Mbed TLS root using the project detection code from the framework. Signed-off-by: David Horstmann <david.horstmann@arm.com>
If docs/requirements.txt is unchanged by the update, do not attempt to make a commit. Signed-off-by: David Horstmann <david.horstmann@arm.com>
Since `python --version` seems to output the major, minor and patch versions, we can safely just check for the second dot character. Signed-off-by: David Horstmann <david.horstmann@arm.com>
davidhorstmann-arm
added
needs-review
Ensure we don't try to commit an update that doesn't exist due to errors, or similar. Signed-off-by: David Horstmann <david.horstmann@arm.com>
7 tasks
yiwu0b11
approved these changes
Jul 10, 2026
yiwu0b11
left a comment
yiwu0b11
left a comment
There was a problem hiding this comment.
LGTM, i'm not sure why is the CI failing, seems unrelated.
Info: Test case was ignored: test_suite_config.crypto_combinations;Config: entropy: NV seed only
--
| | | Error: Test case not executed: test_suite_psa_crypto;PSA generate key custom: RSA, e=3 with driver and no fallback (not yet supported)
| | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA decrypt transparent driver: fallback not available RSA OAEP-SHA-256
| | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA decrypt transparent driver: fallback not available RSA PKCS#1 v1.5
| | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt transparent driver: fallback not available RSA OAEP-SHA-256
| | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt transparent driver: fallback not available RSA PKCS#1 v1.5
| | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt-decrypt transparent driver: fallback not available RSA OAEP-SHA-256
| | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt-decrypt transparent driver: fallback not available RSA PKCS#1 v1.5
| | | Info: Overall results: 0 warnings and 7 errors
Contributor
Author
|
It looks like there were a couple of infrastructure issues. One of them hit the component that tests RSA acceleration and the result analysis detected it as a test case not executed. I'm going to give it a poke and see if that works. |
gilles-peskine-arm
added
priority-high
github-project-automation
Bot
moved this to In Development
in Roadmap pull requests (new board)
gilles-peskine-arm
approved these changes
Jul 20, 2026
gilles-peskine-arm
left a comment
gilles-peskine-arm
left a comment
Contributor
There was a problem hiding this comment.
LGTM although I don't understand the exclusion of TF-PSA-Crypto
Comment on lines
+9
to
+12
| if is_tf_psa_crypto_root $PWD; then | ||
| echo "Error: This script is only for Mbed TLS" | ||
| exit 1 | ||
| fi |
Contributor
There was a problem hiding this comment.
Why shouldn't this script run in TF-PSA-Crypto?
github-project-automation
Bot
moved this from In Development
to Has Approval
in Roadmap pull requests (new board)
gilles-peskine-arm
added
approved
Contributor
|
The CI failed for another intermittent reason. I'm leaving up to you to either rerun the CI and merge, or update to remove the repository restriction. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Add a small script to update the Python packages used to generate the docs in Mbed TLS.
PR checklist
Please add the numbers (or links) of the associated pull requests for consuming branches. You can omit branches where this pull request is not needed.