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

chore: Set track_progress=True by default #66

Merged
merged 9 commits into from
Aug 28, 2023

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Aug 25, 2023

In the notebooks set track_progress=True so that when users run interactively or locally they get information on pseudo-experiments. However, to avoid having huge JupyterBook output (track_progress=True shows iterative updates of the progress bar in the JupyterBook output) have the CI switch this to track_progress=False during the build.

* Set `track_progress=True` for notebook files to give interactive users
  progress information.
* Set `track_progess=False` during the JupyterBook build in CI to avoid having
  the updates of the progress bar information frozen into the built book.
   - Use `git config --global --add safe.directory` to guard against GitHub Actions
     environment erroring with 'fatal: detected dubious ownership in repository'.

Guard against 'fatal: detected dubious ownership in repository'
Comment on lines +40 to +41
git config --global --add safe.directory /__w/pyhf-tutorial/pyhf-tutorial
git grep --name-only "track_progress=True" book | xargs sed --in-place 's/track_progress=True/track_progress=False/g'
Copy link
Member Author

Choose a reason for hiding this comment

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

Note that this doesn't do anything for the Makefile so that might not be ideal.

Copy link
Member Author

Choose a reason for hiding this comment

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

@matthewfeickert
Copy link
Member Author

This is the build view from CI

image

@matthewfeickert matthewfeickert merged commit 3c7bdc2 into main Aug 28, 2023
5 checks passed
@matthewfeickert matthewfeickert deleted the chore/set-track-progress-false branch August 28, 2023 21:12
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.

2 participants