Maintenance: local documentation raises exception when run in docker

[leandrodamascena]

Why is this needed?

When running documentation in docker container we are getting the follow error:

(aws-lambda-powertools-py3.11) ➜  aws-lambda-powertools-v3 git:(docs/mkdocs) ✗ make docs-local-docker                                                     
docker build -t squidfunk/mkdocs-material ./docs/
[+] Building 6.4s (7/7) FINISHED                                                                                                                                                                                                                                               docker:default
 => [internal] load build definition from Dockerfile                                                                                                                                                                                                                                     0.0s
 => => transferring dockerfile: 317B                                                                                                                                                                                                                                                     0.0s
 => [internal] load metadata for docker.io/squidfunk/mkdocs-material@sha256:08fbf586e0963725a58eec1ab067ab9b23b804601e0bc2ddb3ab85a2b1ceeb7f                                                                                                                                             1.2s
 => [internal] load .dockerignore                                                                                                                                                                                                                                                        0.0s
 => => transferring context: 2B                                                                                                                                                                                                                                                          0.0s
 => [internal] load build context                                                                                                                                                                                                                                                        0.0s
 => => transferring context: 13.65kB                                                                                                                                                                                                                                                     0.0s
 => CACHED [1/3] FROM docker.io/squidfunk/mkdocs-material@sha256:08fbf586e0963725a58eec1ab067ab9b23b804601e0bc2ddb3ab85a2b1ceeb7f                                                                                                                                                        0.0s
 => [2/3] COPY requirements.txt /tmp/                                                                                                                                                                                                                                                    0.1s
 => ERROR [3/3] RUN pip install --require-hashes -r /tmp/requirements.txt                                                                                                                                                                                                                5.1s
------                                                                                                                                                                                                                                                                                        
 > [3/3] RUN pip install --require-hashes -r /tmp/requirements.txt:                                                                                                                                                                                                                           
0.737 Collecting click==8.1.3 (from -r /tmp/requirements.txt (line 7))                                                                                                                                                                                                                        
0.864   Downloading click-8.1.3-py3-none-any.whl (96 kB)                                                                                                                                                                                                                                      
0.912 Requirement already satisfied: ghp-import==2.1.0 in /usr/local/lib/python3.11/site-packages (from -r /tmp/requirements.txt (line 11)) (2.1.0)                                                                                                                                           
0.947 Collecting gitdb==4.0.10 (from -r /tmp/requirements.txt (line 15))                                                                                                                                                                                                                      
0.966   Downloading gitdb-4.0.10-py3-none-any.whl (62 kB)
1.034 Collecting gitpython==3.1.41 (from -r /tmp/requirements.txt (line 19))
1.057   Downloading GitPython-3.1.41-py3-none-any.whl (196 kB)
1.176 Collecting importlib-metadata==7.0.1 (from -r /tmp/requirements.txt (line 23))
1.195   Downloading importlib_metadata-7.0.1-py3-none-any.whl (23 kB)
1.205 Requirement already satisfied: jinja2==3.1.4 in /usr/local/lib/python3.11/site-packages (from -r /tmp/requirements.txt (line 29)) (3.1.4)
1.240 Collecting markdown==3.3.7 (from -r /tmp/requirements.txt (line 35))
1.261   Downloading Markdown-3.3.7-py3-none-any.whl (97 kB)
1.364 Collecting markupsafe==2.1.3 (from -r /tmp/requirements.txt (line 39))
1.380   Downloading MarkupSafe-2.1.3-cp311-cp311-musllinux_1_1_aarch64.whl (33 kB)
1.390 Requirement already satisfied: mergedeep==1.3.4 in /usr/local/lib/python3.11/site-packages (from -r /tmp/requirements.txt (line 91)) (1.3.4)
1.534 Collecting mkdocs==1.4.3 (from -r /tmp/requirements.txt (line 95))
1.554   Downloading mkdocs-1.4.3-py3-none-any.whl (3.7 MB)
1.891      ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.7/3.7 MB 10.9 MB/s eta 0:00:00
2.023 Collecting mkdocs-git-revision-date-plugin==0.3.2 (from -r /tmp/requirements.txt (line 99))
2.044   Downloading mkdocs_git_revision_date_plugin-0.3.2-py3-none-any.whl (4.2 kB)
2.095 Collecting packaging==23.1 (from -r /tmp/requirements.txt (line 102))
2.111   Downloading packaging-23.1-py3-none-any.whl (48 kB)
2.165 Collecting python-dateutil==2.8.2 (from -r /tmp/requirements.txt (line 106))
2.183   Downloading python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB)
2.277 Collecting pyyaml==6.0 (from -r /tmp/requirements.txt (line 110))
2.293   Downloading PyYAML-6.0.tar.gz (124 kB)
2.384   Installing build dependencies: started
4.600   Installing build dependencies: finished with status 'done'
4.600   Getting requirements to build wheel: started
4.852   Getting requirements to build wheel: finished with status 'error'
4.854   error: subprocess-exited-with-error
4.854   
4.854   × Getting requirements to build wheel did not run successfully.
4.854   │ exit code: 1
4.854   ╰─> [54 lines of output]
4.854       running egg_info
4.854       writing lib/PyYAML.egg-info/PKG-INFO
4.854       writing dependency_links to lib/PyYAML.egg-info/dependency_links.txt
4.854       writing top-level names to lib/PyYAML.egg-info/top_level.txt
4.854       Traceback (most recent call last):
4.854         File "/usr/local/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 353, in <module>
4.854           main()
4.854         File "/usr/local/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 335, in main
4.854           json_out['return_val'] = hook(**hook_input['kwargs'])
4.854                                    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4.854         File "/usr/local/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 118, in get_requires_for_build_wheel
4.854           return hook(config_settings)
4.854                  ^^^^^^^^^^^^^^^^^^^^^
4.854         File "/tmp/pip-build-env-_3jzn4j2/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 332, in get_requires_for_build_wheel
4.854           return self._get_build_requires(config_settings, requirements=[])

Which area does this relate to?

Automation

Solution

Recreate the file requirements.txt with the new pinned versions.

Acknowledgment

• This request meets Powertools for AWS Lambda (Python) Tenets
• Should this be considered in other Powertools for AWS Lambda languages? i.e. Java, TypeScript, and .NET

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.

[github-actions]

This is now released under 3.1.0 version!