wpilibsuite / sphinxext-opengraph

Sphinx extension to generate unique OpenGraph metadata
https://sphinxext-opengraph.readthedocs.io
Other
74 stars 27 forks source link

Test multiple Sphinx and OS versions #70

Closed hugovk closed 1 year ago

hugovk commented 1 year ago

Fixes https://github.com/wpilibsuite/sphinxext-opengraph/issues/36.

Includes PR https://github.com/wpilibsuite/sphinxext-opengraph/pull/67 to avoid conflicts.


https://github.com/wpilibsuite/sphinxext-opengraph/issues/36#issuecomment-769327008 says:

We should test on all platforms.

The workflow should be:

  1. ubuntu python3.6 builds the wheel and uploads it as an artifact
  2. [win, mac, ubuntu] x [py 3.6, 3.7, 3.8, 3.9] download and test the wheel
  3. ubuntu uploads the wheel

So let's do this, except using Python 3.7 instead of removed EOL 3.6, and testing the wheel on 3.7-3.11.


Further, https://github.com/wpilibsuite/sphinxext-opengraph/issues/36#issuecomment-769425328 says:

We should also test on major supported sphinx versions

So let's also test on Sphinx 4, 5 and 6 beta.


image

https://github.com/hugovk/sphinxext-opengraph/actions/runs/3263561876

hugovk commented 1 year ago

These required checks will need updating:

image

Because it can be tedious work removing and adding these in the settings when Python versions change, one option is to have a final no-op job that depends on the others. And then just mark that final as required.

For example:

https://github.com/hugovk/norwegianblue/blob/8cb61db6dd8a7f5d4e19c389eb91a70c820354d7/.github/workflows/test.yml#L49-L55

image

https://github.com/hugovk/norwegianblue/actions/runs/3177642324

Would you like something similar here?

Daltz333 commented 1 year ago

Merging, and an issue can be opened for continue discussion. Gotta update the CI checks. Thanks!