Enabling Google analytics throws error on build

[goncalo-oliveira]

Hi,

I'm having some difficulties on building with CI only, on Netlify. On my machine it seems to be working, but on the CI script it seems to fail and I'm not sure where I should look for differences.

The only difference that is clear is Phython's version. I have installed pip 23.0.1 with python 3.10 and Netlify only supports 3.8 (for the time being).

This is the yaml block that causes the issue; if removed, it builds properly

extra:
  analytics:
    provider: Google
    property: G-XXXXXXXXXX

I've executed pip freeze into a requirements.txt to make sure the same package versions are installed.

certifi==2022.12.7
charset-normalizer==3.1.0
click==8.1.3
colorama==0.4.6
ghp-import==2.1.0
idna==3.4
Jinja2==3.1.2
Markdown==3.3.7
MarkupSafe==2.1.2
mergedeep==1.3.4
mkdocs==1.4.2
mkdocs-material==9.1.5
mkdocs-material-extensions==1.1.1
numpy==1.24.2
packaging==23.0
protobuf==4.21.12
Pygments==2.14.0
pymdown-extensions==9.10
python-dateutil==2.8.2
PyYAML==6.0
pyyaml_env_tag==0.1
regex==2023.3.23
requests==2.28.2
six==1.16.0
urllib3==1.26.15
watchdog==3.0.0

If I run mkdocs build on my machine, everything works fine. On Netlify, I get a template not found error

jinja2.exceptions.TemplateNotFound: partials/integrations/analytics/Google.html

Further logs from the build

3:54:28 PM: Starting to install dependencies
3:54:28 PM: Python version set to 3.8
3:54:28 PM: Installing pip dependencies
3:54:28 PM: Started restoring cached pip cache
3:54:28 PM: Finished restoring cached pip cache
3:54:29 PM: Requirement already satisfied: certifi==2022.12.7 in /opt/buildhome/python3.8/lib/python3.8/site-packages (from -r requirements.txt (line 1)) (2022.12.7)
3:54:29 PM: Collecting charset-normalizer==3.1.0
3:54:29 PM:   Using cached charset_normalizer-3.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (195 kB)
3:54:29 PM: Collecting click==8.1.3
3:54:29 PM:   Using cached click-8.1.3-py3-none-any.whl (96 kB)
3:54:29 PM: Collecting colorama==0.4.6
3:54:29 PM:   Using cached colorama-0.4.6-py2.py3-none-any.whl (25 kB)
3:54:29 PM: Collecting ghp-import==2.1.0
3:54:29 PM:   Using cached ghp_import-2.1.0-py3-none-any.whl (11 kB)
3:54:29 PM: Collecting idna==3.4
3:54:29 PM:   Using cached idna-3.4-py3-none-any.whl (61 kB)
3:54:30 PM: Collecting Jinja2==3.1.2
3:54:30 PM:   Using cached Jinja2-3.1.2-py3-none-any.whl (133 kB)
3:54:30 PM: Collecting Markdown==3.3.7
3:54:30 PM:   Using cached Markdown-3.3.7-py3-none-any.whl (97 kB)
3:54:30 PM: Collecting MarkupSafe==2.1.2
3:54:30 PM:   Using cached MarkupSafe-2.1.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB)
3:54:30 PM: Collecting mergedeep==1.3.4
3:54:30 PM:   Using cached mergedeep-1.3.4-py3-none-any.whl (6.4 kB)
3:54:30 PM: Collecting mkdocs==1.4.2
3:54:30 PM:   Using cached mkdocs-1.4.2-py3-none-any.whl (3.7 MB)
3:54:30 PM: Collecting mkdocs-material==9.1.5
3:54:30 PM:   Downloading mkdocs_material-9.1.5-py3-none-any.whl (7.8 MB)
3:54:31 PM: Collecting mkdocs-material-extensions==1.1.1
3:54:31 PM:   Using cached mkdocs_material_extensions-1.1.1-py3-none-any.whl (7.9 kB)
3:54:31 PM: Collecting numpy==1.24.2
3:54:31 PM:   Downloading numpy-1.24.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (17.3 MB)
3:54:32 PM: Collecting packaging==23.0
3:54:32 PM:   Using cached packaging-23.0-py3-none-any.whl (42 kB)
3:54:32 PM: Collecting protobuf==4.21.12
3:54:32 PM:   Downloading protobuf-4.21.12-cp37-abi3-manylinux2014_x86_64.whl (409 kB)
3:54:32 PM: Collecting Pygments==2.14.0
3:54:32 PM:   Using cached Pygments-2.14.0-py3-none-any.whl (1.1 MB)
3:54:32 PM: Collecting pymdown-extensions==9.10
3:54:32 PM:   Using cached pymdown_extensions-9.10-py3-none-any.whl (235 kB)
3:54:32 PM: Collecting python-dateutil==2.8.2
3:54:32 PM:   Using cached python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB)
3:54:32 PM: Collecting PyYAML==6.0
3:54:32 PM:   Using cached PyYAML-6.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (701 kB)
3:54:33 PM: Collecting pyyaml_env_tag==0.1
3:54:33 PM:   Using cached pyyaml_env_tag-0.1-py3-none-any.whl (3.9 kB)
3:54:33 PM: Collecting regex==2023.3.23
3:54:33 PM:   Using cached regex-2023.3.23-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (771 kB)
3:54:33 PM: Collecting requests==2.28.2
3:54:33 PM:   Using cached requests-2.28.2-py3-none-any.whl (62 kB)
3:54:33 PM: Collecting six==1.16.0
3:54:33 PM:   Using cached six-1.16.0-py2.py3-none-any.whl (11 kB)
3:54:33 PM: Collecting urllib3==1.26.15
3:54:33 PM:   Using cached urllib3-1.26.15-py2.py3-none-any.whl (140 kB)
3:54:33 PM: Collecting watchdog==3.0.0
3:54:33 PM:   Using cached watchdog-3.0.0-py3-none-manylinux2014_x86_64.whl (82 kB)
3:54:33 PM: Collecting importlib-metadata>=4.4; python_version < "3.10"
3:54:33 PM:   Using cached importlib_metadata-6.1.0-py3-none-any.whl (21 kB)
3:54:34 PM: Collecting zipp>=0.5
3:54:34 PM:   Using cached zipp-3.15.0-py3-none-any.whl (6.8 kB)
3:54:34 PM: Installing collected packages: charset-normalizer, click, colorama, six, python-dateutil, ghp-import, idna, MarkupSafe, Jinja2, zipp, importlib-metadata, Markdown, mergedeep, packaging, PyYAML, pyyaml-env-tag, watchdog, mkdocs, mkdocs-material-extensions, regex, urllib3, requests, Pygments, pymdown-extensions, mkdocs-material, numpy, protobuf
3:54:39 PM: Successfully installed Jinja2-3.1.2 Markdown-3.3.7 MarkupSafe-2.1.2 PyYAML-6.0 Pygments-2.14.0 charset-normalizer-3.1.0 click-8.1.3 colorama-0.4.6 ghp-import-2.1.0 idna-3.4 importlib-metadata-6.1.0 mergedeep-1.3.4 mkdocs-1.4.2 mkdocs-material-9.1.5 mkdocs-material-extensions-1.1.1 numpy-1.24.2 packaging-23.0 protobuf-4.21.12 pymdown-extensions-9.10 python-dateutil-2.8.2 pyyaml-env-tag-0.1 regex-2023.3.23 requests-2.28.2 six-1.16.0 urllib3-1.26.15 watchdog-3.0.0 zipp-3.15.0
3:54:39 PM: Pip dependencies installed
3:54:50 PM:   - cli.md
3:54:50 PM: Traceback (most recent call last):
3:54:50 PM:   File "/opt/buildhome/python3.8/bin/mkdocs", line 8, in <module>
3:54:50 PM:     sys.exit(cli())
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1130, in __call__
3:54:50 PM:     return self.main(*args, **kwargs)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1055, in main
3:54:50 PM:     rv = self.invoke(ctx)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1657, in invoke
3:54:50 PM:     return _process_result(sub_ctx.command.invoke(sub_ctx))
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 1404, in invoke
3:54:50 PM:     return ctx.invoke(self.callback, **ctx.params)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/click/core.py", line 760, in invoke
3:54:50 PM:     return __callback(*args, **kwargs)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/__main__.py", line 250, in build_command
3:54:50 PM:     build.build(cfg, dirty=not clean)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/commands/build.py", line 320, in build
3:54:50 PM:     _build_theme_template(template, env, files, config, nav)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/commands/build.py", line 118, in _build_theme_template
3:54:52 PM: Failed during stage 'building site': Build script returned non-zero exit code: 2 (https://ntl.fyi/exit-code-2)
3:54:50 PM:     output = _build_template(template_name, template, files, config, nav)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/mkdocs/commands/build.py", line 97, in _build_template
3:54:50 PM:     output = template.render(context)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/jinja2/environment.py", line 1301, in render
3:54:50 PM:     self.environment.handle_exception()
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/jinja2/environment.py", line 936, in handle_exception
3:54:50 PM:     raise rewrite_traceback_stack(source=source)
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/material/404.html", line 4, in top-level template code
3:54:50 PM:     {% extends "main.html" %}
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/material/main.html", line 4, in top-level template code
3:54:50 PM:     {% extends "base.html" %}
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/material/base.html", line 67, in top-level template code
3:54:50 PM:     {% block analytics %}
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/material/base.html", line 68, in block 'analytics'
3:54:50 PM:     {% include "partials/integrations/analytics.html" %}
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/material/partials/integrations/analytics.html", line 8, in top-level template code
3:54:50 PM:     {% include "partials/integrations/analytics/" ~ provider ~ ".html" %}
3:54:50 PM:   File "/opt/buildhome/python3.8/lib/python3.8/site-packages/jinja2/loaders.py", line 218, in get_source
3:54:50 PM:     raise TemplateNotFound(template)
3:54:50 PM: jinja2.exceptions.TemplateNotFound: partials/integrations/analytics/Google.html
3:54:50 PM: ​
3:54:50 PM:   "build.command" failed   

I'm not a Python expert so if anyone can point me out on the right direction I'd appreciate it. I'm sure this is probably a configuration or dependency issue.

[squidfunk]

Your configuration has a syntax error:

extra:
  analytics:
    provider: google # <-- must be lowercase
    property: G-XXXXXXXXXX

Our documentation mentions the correct syntax.

[goncalo-oliveira]

The victims of case sensitivity 😆
That was indeed the issue and now the error makes sense...
Thank you for replying!