Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

introduce conda-lock file for docs #4553

Merged
merged 2 commits into from
Dec 8, 2023
Merged

introduce conda-lock file for docs #4553

merged 2 commits into from
Dec 8, 2023

Conversation

cosmicBboy
Copy link
Contributor

@cosmicBboy cosmicBboy commented Dec 7, 2023

Tracking issue

https://github.com/flyteorg/flyte/issues/

Why are the changes needed?

To pin docs building dependencies.

What changes were proposed in this pull request?

How was this patch tested?

  • Ran the conda-lock make command
  • Re-create the environment with the conda lock file.

@dosubot dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Dec 7, 2023
Copy link

codecov bot commented Dec 7, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (e221f9f) 58.92% compared to head (36c519e) 58.92%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #4553      +/-   ##
==========================================
- Coverage   58.92%   58.92%   -0.01%     
==========================================
  Files         620      620              
  Lines       52432    52432              
==========================================
- Hits        30896    30895       -1     
- Misses      19071    19072       +1     
  Partials     2465     2465              
Flag Coverage Δ
unittests 58.92% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dosubot dosubot bot added size:XXL This PR changes 1000+ lines, ignoring generated files. size:M This PR changes 30-99 lines, ignoring generated files. size:S This PR changes 10-29 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. size:XXL This PR changes 1000+ lines, ignoring generated files. size:M This PR changes 30-99 lines, ignoring generated files. labels Dec 7, 2023
Signed-off-by: Niels Bantilan <[email protected]>
Comment on lines +11 to +18
commands:
- cat monodocs-environment.lock.yaml
- mamba install -c conda-forge conda-lock
- conda-lock install -p /home/docs/monodocs-env monodocs-environment.lock.yaml
- conda info
- conda env list
- cat docs/conf.py
- cd docs && /home/docs/monodocs-env/bin/python -m sphinx -T -E -b html -d docs/_build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thomasjpfan minor risk (IMO) is that builds.command key is in beta and may change in the future.

Copy link
Member

@thomasjpfan thomasjpfan Dec 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried a solution in https://github.com/thomasjpfan/conda-lock-sphinx-test, which works on readthedocs. It uses a noop.yml to create a small environment and immediately overrides it with conda-lock.

I wanted to configure it without the noop.yml, but readthedocs fails to build without it.

As long as it works, I prefer the build.command approach. If it breaks in the future, there is a workaround.

Comment on lines +11 to +18
commands:
- cat monodocs-environment.lock.yaml
- mamba install -c conda-forge conda-lock
- conda-lock install -p /home/docs/monodocs-env monodocs-environment.lock.yaml
- conda info
- conda env list
- cat docs/conf.py
- cd docs && /home/docs/monodocs-env/bin/python -m sphinx -T -E -b html -d docs/_build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Copy link
Member

@thomasjpfan thomasjpfan Dec 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried a solution in https://github.com/thomasjpfan/conda-lock-sphinx-test, which works on readthedocs. It uses a noop.yml to create a small environment and immediately overrides it with conda-lock.

I wanted to configure it without the noop.yml, but readthedocs fails to build without it.

As long as it works, I prefer the build.command approach. If it breaks in the future, there is a workaround.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 8, 2023
@cosmicBboy cosmicBboy merged commit f440278 into master Dec 8, 2023
40 of 41 checks passed
@cosmicBboy cosmicBboy deleted the monodocs-conda-lock branch December 8, 2023 21:20
pvditt pushed a commit that referenced this pull request Dec 13, 2023
* introduce conda-lock file for docs

Signed-off-by: Niels Bantilan <[email protected]>

* add back _version.py

Signed-off-by: Niels Bantilan <[email protected]>

---------

Signed-off-by: Niels Bantilan <[email protected]>
Signed-off-by: Paul Dittamo <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants