Why is this PR needed?
Currently, I think we are running tests with XVFB when we use.xvfb is false, which is the default. This is confusing.
For an example see the Ubuntu 3.8 run at https://github.com/brainglobe/bg-atlasapi/actions/runs/5933797577/job/16089742691
(This may additionally slow down our tests when we don't need XVFB)
What does this PR do?
Ensures XVFB is run when use.xvfb is true
References
Closes #21
How has this PR been tested?
Double-checking understanding with office mates and doing my best to reason logically!
Is this a breaking change?
Yes, it might break downstream workflows that need xvfb but haven't specified use-xvfb: true in their YAML file?
Does this PR require an update to the documentation?
Nope.
Checklist:
[n/a] The code has been tested locally
[n/a] Tests have been added to cover all new functionality
[n/a] The documentation has been updated to reflect any changes
Description
What is this PR
Why is this PR needed? Currently, I think we are running tests with XVFB when we
use.xvfbis false, which is the default. This is confusing. For an example see the Ubuntu 3.8 run at https://github.com/brainglobe/bg-atlasapi/actions/runs/5933797577/job/16089742691 (This may additionally slow down our tests when we don't need XVFB)What does this PR do?
Ensures XVFB is run when
use.xvfbistrueReferences
Closes #21
How has this PR been tested?
Double-checking understanding with office mates and doing my best to reason logically!
Is this a breaking change?
Yes, it might break downstream workflows that need xvfb but haven't specified
use-xvfb: truein their YAML file?Does this PR require an update to the documentation?
Nope.
Checklist: