Skip to content

Fix building docs via justfile on MacOS - #14124

Open
ajaust wants to merge 1 commit into
equinor:mainfrom
ajaust:fix-justfile-docs-build-macos
Open

Fix building docs via justfile on MacOS#14124
ajaust wants to merge 1 commit into
equinor:mainfrom
ajaust:fix-justfile-docs-build-macos

Conversation

@ajaust

@ajaust ajaust commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Issue
No issue attached. This showed up when working on another issue.

Approach
cp --recursive does not exist on MacOS so use cp -r instead. Also removes temporary folder after extraction of screenshot baselines.

  • PR title captures the intent of the changes, and is fitting for release notes.
  • Added appropriate release note label
  • Commit history is consistent and clean, in line with the contribution guidelines.
  • Make sure unit tests pass locally after every commit (git rebase -i main --exec 'just rapid-tests')

When applicable

  • When screenshots are changed: Review screenshot-PR in ert-testdata,
    merge screenshot-PR in ert-testdata before merging this PR.
  • When there are user facing changes: Updated documentation
  • New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
  • Large PR: Prepare changes in small commits for more convenient review
  • Bug fix: Add regression test for the bug
  • Bug fix: Add backport label to latest release (format: 'backport release-branch-name')

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR adjusts the just docs build workflow to be macOS-compatible by replacing a GNU cp long option with a portable flag, and it adds cleanup for the temporary ert-testdata clone used to fetch screenshot baselines.

Changes:

  • Replace cp --recursive with cp -r in fetch-screenshot-baselines to support macOS.
  • Add cleanup of .tmp/ert-testdata after docs build (with a recommendation to move that cleanup into the fetch step so it also runs when sphinx-build fails).

Comment thread justfile Outdated
`cp --recursive` does not exist on MacOS so use `cp -r` instead. Also
removes temporary folder after extraction of screenshot baselines.
@ajaust
ajaust force-pushed the fix-justfile-docs-build-macos branch from 7cf1f8a to 6960987 Compare August 7, 2026 14:36
@ajaust
ajaust requested a lite review from Copilot August 7, 2026 14:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

Suppressed comments (1)

justfile:89

  • git clone ... .tmp/ert-testdata will fail on a clean checkout if the .tmp parent directory does not already exist (it isn't in the repository). The recipe should create .tmp before cloning to make just build-ert-docs reliable on fresh environments.
    rm -rf .tmp/ert-testdata
    git clone --depth 1 --filter=blob:none --sparse https://github.com/equinor/ert-testdata.git .tmp/ert-testdata
    cd .tmp/ert-testdata && git sparse-checkout set screenshotbaselines
    cp -r .tmp/ert-testdata/screenshotbaselines/. .
    rm -rf .tmp/ert-testdata

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ajaust
ajaust marked this pull request as ready for review August 7, 2026 14:42
@ajaust ajaust added this to SCOUT Aug 7, 2026
@ajaust ajaust moved this to Ready for Review in SCOUT Aug 7, 2026
@codecov-commenter

codecov-commenter commented Aug 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.92%. Comparing base (31248f9) to head (6960987).
⚠️ Report is 29 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #14124      +/-   ##
==========================================
+ Coverage   91.85%   91.92%   +0.07%     
==========================================
  Files         484      482       -2     
  Lines       33581    33493      -88     
==========================================
- Hits        30847    30790      -57     
+ Misses       2734     2703      -31     
Flag Coverage Δ
cli-tests 36.23% <ø> (+0.05%) ⬆️
fuzz 44.23% <ø> (+0.14%) ⬆️
gui-tests 58.61% <ø> (+0.21%) ⬆️
performance-and-unit-tests 80.80% <ø> (+0.33%) ⬆️
test 46.05% <ø> (-0.27%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 33 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

3 participants