8000 CI reduce verbosity of build_doc.sh by ogrisel · Pull Request #23557 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

CI reduce verbosity of build_doc.sh #23557

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

Merged
merged 6 commits into from
Jun 7, 2022

Conversation

ogrisel
Copy link
Member
@ogrisel ogrisel commented Jun 7, 2022

The log of the documentation build is very verbose and can sometimes lead firefox to display black pages with a very long scroll bars for several seconds making it painful to read the error message when working on a failing example (e.g. https://github.com/scikit-learn/scikit-learn/runs/6754051284?check_suite_focus=true).

This PRs changes a few things in the build_doc.sh script to make that log shorter and focused on documentation related issues:

  • pass -q to wget to avoid the expanded download progress bar for the mambaforge installer
  • try to use set -v instead of set -x remove all verbose bash options
  • the the log level of conda-lock to WARNING instead of INFO to avoid redundant mamba installation output (we already do a mamba list at the end).
  • build scikit-learn with pip to hide the build log by default when there is not build problem.

I also renamed variables related to miniconda to account 8000 for the switch to mambaforge.

@ogrisel
Copy link
Member Author
ogrisel commented Jun 7, 2022

We need to properly configure a per-branch or per-PR cache folder to be reused for ccache to work as expected for the doc builds but I would rather not do it as part of this PR.

I think this is already a net improvement: the logs of the last is much easier to parse than previously. See for instance this log:

https://github.com/scikit-learn/scikit-learn/runs/6771165338?check_suite_focus=true

@ogrisel
Copy link
Member Author
ogrisel commented Jun 7, 2022

/cc @cmarmo @thomasjpfan @alfaro96

Copy link
Member
@alfaro96 alfaro96 left a comment

Choose a reason for hiding this comment

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

Thanks @ogrisel. I agree that we should reduce the verbosity of that script. LGTM.

Copy link
Member
@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

I agree this is more readable. LGTM

@thomasjpfan thomasjpfan merged commit a4a53ea into scikit-learn:main Jun 7, 2022
@ogrisel ogrisel deleted the less-verbose-build_doc.sh branch June 8, 2022 08:29
ogrisel added a commit to ogrisel/scikit-learn that referenced this pull request Jul 11, 2022
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0