Update headless-gui action in build (fix screenshots) #294

aganders3 · 2023-12-05T21:25:00Z

References and relevant issues

~~Hopefully f i x e s~~ Pretty sure now this fixes both #283 and #285

Description

This configures the headless-gui action to not run the tiling window manager it uses by default. My thinking is the tiling behavior in the window manager is causing issues with certain screenshots. See #283 (comment) for more details.

This also updates the action to a new version with a more common default screen size. This change in bit-depth fixes the messed up magicgui screenshot.

Edit: I'm still not totally clear why the stable docs would look okay but I think this is worth trying.

See napari#283 (comment) for more details.

psobolewskiPhD · 2023-12-05T21:33:18Z

Fingers crossed!
Stable docs are from July so maybe something changed?
Good news is that I'm pretty sure if the build artifact is fine then the deployed will also be fine, so we can test easily.

Edit2: Oh and @aganders3 could you also--optimistically--edit the deploy action?

docs/.github/workflows/deploy_docs.yml

Lines 56 to 65 in 0c7029e

    
                 - name: Build Docs 
        
                   uses: aganders3/headless-gui@v1 
        
                   env: 
        
                     GOOGLE_CALENDAR_ID: ${{ secrets.GOOGLE_CALENDAR_ID }} 
        
                     GOOGLE_CALENDAR_API_KEY: ${{ secrets.GOOGLE_CALENDAR_API_KEY }} 
        
                     PIP_CONSTRAINT: ${{ github.workspace }}/napari-repo/resources/constraints/constraints_py3.10_docs.txt 
        
                   with: 
        
                     # the napari-docs repo is cloned into a docs/ folder, hence the 
        
                     # invocation below. Locally, you should simply run make docs 
        
                     run: make -C docs docs GALLERY_PATH=../examples/

aganders3 · 2023-12-05T21:37:31Z

Good news is that I'm pretty sure if the build artifact is fine then the deployed will also be fine, so we can test easily.

Nice - hopefully.

Bad news is I think I need to push a change and run it again because I think it needs a non-empty string to avoid the defaults 🤦.

edit: and we need to keep waiting because as I am learning about JavaScript and GH-Actions APIs in real-time 🤦🤦.

aganders3 · 2023-12-05T21:57:31Z

Just pointing out a weird traceback here in a recent build - possibly related but let's see how the docs look before I change anything else (for example trying another WM).
https://github.com/napari/docs/actions/runs/7106959550/job/19347465882#step:8:202

aganders3 · 2023-12-05T22:02:02Z

Hm, the first screenshot on that page is still messed up, but the rest look better.

I am looking at this build: https://github.com/napari/docs/actions/runs/7106959550

psobolewskiPhD · 2023-12-05T22:10:28Z

Yeah, the size is fixed, but the first widget is messed up. So I guess this fixes #285 only at the moment.

aganders3 · 2023-12-06T03:02:52Z

Okay actually I think that worked!

@lucyleeow @psobolewskiPhD can you check the latest build?
https://github.com/napari/docs/actions/runs/7109505974

I converted to draft because this will still need a new release on the action.

psobolewskiPhD · 2023-12-06T03:43:16Z

yes! Looks correct now in the artifact. I don't see issues in other pages!

.github/workflows/deploy_docs.yml

.github/workflows/build_docs.yml

psobolewskiPhD · 2023-12-06T15:13:25Z

@Czaki I saw the same problems in the artifact from the 0.4.19 docs PR, so I think this will need to be cherry picked over to that branch.

aganders3 · 2023-12-06T15:15:35Z

Okay I'm pretty sure this is good-to-go now using headless-gui@v2. Sorry everyone!

psobolewskiPhD

I just checked the latest artifact and everything looks good.

.github/workflows/build_docs.yml

Co-authored-by: Peter Sobolewski <[email protected]>

.circleci/config.yml

lucyleeow · 2023-12-11T22:19:29Z

Should we get another review? Not sure who would be best...

lucyleeow · 2023-12-11T22:24:56Z

Also I question, I see from here: #283 (comment) it seems that the setup in GH and CircleCI is different.

Would trying to mimic Talleys QT setup action to get consistency between CI workflows be a good idea?

psobolewskiPhD · 2023-12-11T23:24:45Z

Also I question, I see from here: #283 (comment) it seems that the setup in GH and CircleCI is different.

Would trying to mimic Talleys QT setup action to get consistency between CI workflows be a good idea?

Not sure if the differences are a) required or b) significant. Either way I think changes to CircleCI workflows are out of scope of this PR, but maybe worth noting in an issue?

lucyleeow · 2023-12-11T23:35:58Z

No problem, it is more from a maintenance point of view - I guess we assume they both do the same thing, and if the docs look fine in CircleCI we assume they would look okay when we deploy but they use slightly different workflows? I am no good with Qt and window stuff though. (And I really don't know the ins and outs of our doc CIs)
And yes, further changes are definitely out of scope of this PR.

aganders3 · 2023-12-15T21:53:52Z

Thanks for merging @psobolewskiPhD 🚀

Note it did not close the two associated bugs automatically, probably because I edited in the "closing words". 🙁

psobolewskiPhD · 2023-12-16T00:03:54Z

I just wanted to be sure after deployment. Looks good though:
https://napari.org/dev/guides/magicgui.html

# Description This PR updates the build_docs workflow to match the latest napari/docs workflow Specifically add concurrency (napari/docs PR: napari/docs#277 ) and to fix graphical issues related to the xvfb action ( napari/docs PR: napari/docs#294 )

This PR updates the build_docs workflow to match the latest napari/docs workflow Specifically add concurrency (napari/docs PR: napari/docs#277 ) and to fix graphical issues related to the xvfb action ( napari/docs PR: napari/docs#294 )

Don't run window manager in headless-gui action during build

2c1aefb

See napari#283 (comment) for more details.

github-actions bot assigned aganders3 Dec 5, 2023

github-actions bot added the task label Dec 5, 2023

psobolewskiPhD added maintenance CI, dependencies, and other maintenance bug Something isn't working labels Dec 5, 2023

psobolewskiPhD added this to the 0.5.0 milestone Dec 5, 2023

aganders3 added 3 commits December 5, 2023 16:39

Make headless-gui configs non-empty (but empty)

a875960

Update deploy_docs.yml as well

cc57d39

Try a different way to skip

5bdd8e1

aganders3 added 2 commits December 5, 2023 19:56

Try PySide for some reason

d02427b

Use headless-gui dev branch

e2175d7

aganders3 force-pushed the patch-2 branch 3 times, most recently from 391c66f to bd3775c Compare December 6, 2023 02:40

Use xvfb-screen-size

adb45bc

aganders3 force-pushed the patch-2 branch from bd3775c to adb45bc Compare December 6, 2023 02:43

aganders3 marked this pull request as draft December 6, 2023 03:00

psobolewskiPhD reviewed Dec 6, 2023

View reviewed changes

.github/workflows/deploy_docs.yml Outdated Show resolved Hide resolved

lucyleeow reviewed Dec 6, 2023

View reviewed changes

.github/workflows/build_docs.yml Outdated Show resolved Hide resolved

Update to use released headless-gui@v2 with new default screen size

0f32623

aganders3 marked this pull request as ready for review December 6, 2023 15:14

psobolewskiPhD approved these changes Dec 6, 2023

View reviewed changes

psobolewskiPhD reviewed Dec 6, 2023

View reviewed changes

.github/workflows/build_docs.yml Outdated Show resolved Hide resolved

psobolewskiPhD reviewed Dec 6, 2023

View reviewed changes

.github/workflows/build_docs.yml Outdated Show resolved Hide resolved

Use pyqt (via all) instead of pyside when installing napari

54fcbdd

Co-authored-by: Peter Sobolewski <[email protected]>

aganders3 changed the title ~~Don't run window manager in headless-gui action during build~~ Update headless-gui action in build (fix screenshots) Dec 6, 2023

psobolewskiPhD reviewed Dec 11, 2023

View reviewed changes

.circleci/config.yml Outdated Show resolved Hide resolved

Don't change .circleci/config.yml

3d1f64d

psobolewskiPhD added the ready to merge label Dec 11, 2023

Czaki approved these changes Dec 11, 2023

View reviewed changes

psobolewskiPhD merged commit 85636bc into napari:main Dec 15, 2023

psobolewskiPhD removed the ready to merge label Dec 15, 2023

aganders3 deleted the patch-2 branch December 15, 2023 19:18

This was linked to issues Dec 16, 2023

Widget screenshot in magicgui.md error #283

Closed

Problem screenshots in "Using magicgui in napari" in dev #285

Closed

This was referenced Dec 16, 2023

Widget screenshot in magicgui.md error #283

Closed

Problem screenshots in "Using magicgui in napari" in dev #285

Closed

[Maint] Update build_docs workflow to match napari/docs napari/napari#6547

Merged

Update headless-gui action in build (fix screenshots) #294

Update headless-gui action in build (fix screenshots) #294

Uh oh!

Conversation

aganders3 commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

References and relevant issues

Description

Uh oh!

psobolewskiPhD commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aganders3 commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aganders3 commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aganders3 commented Dec 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

psobolewskiPhD commented Dec 5, 2023

Uh oh!

aganders3 commented Dec 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

psobolewskiPhD commented Dec 6, 2023

Uh oh!

Uh oh!

Uh oh!

psobolewskiPhD commented Dec 6, 2023

Uh oh!

aganders3 commented Dec 6, 2023

Uh oh!

psobolewskiPhD left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lucyleeow commented Dec 11, 2023

Uh oh!

lucyleeow commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

psobolewskiPhD commented Dec 11, 2023

Uh oh!

lucyleeow commented Dec 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aganders3 commented Dec 15, 2023

Uh oh!

psobolewskiPhD commented Dec 16, 2023

Uh oh!

Uh oh!

aganders3 commented Dec 5, 2023 •

edited

Loading

psobolewskiPhD commented Dec 5, 2023 •

edited

Loading

aganders3 commented Dec 5, 2023 •

edited

Loading

aganders3 commented Dec 5, 2023 •

edited

Loading

aganders3 commented Dec 5, 2023 •

edited

Loading

aganders3 commented Dec 6, 2023 •

edited

Loading

lucyleeow commented Dec 11, 2023 •

edited

Loading

lucyleeow commented Dec 11, 2023 •

edited

Loading