MAINT: Refactor workflows to reduce test dependencies #1136

drammock · 2023-01-25T23:01:32Z

this PR:

extracts our most common workflow step (setup Python env) into a reusable action
refactors the main workflow file to separate pytest stuff and sphinx-build stuff into separate jobs.
updates pyproject.toml to eliminate the separate test and coverage optional dependency groups, and removes pytest and pytest-regressions from the docs group
removes the tests that require ablog

Hopefully now pip install .[doc] gets all and only the things needed for doc builds, and pip install .[test] actually gets all and only the things needed for pytest runs.

drammock · 2023-01-26T00:03:06Z

FWIW the failing jobs are because I'm trying to call a reusable workflow at the step level instead of as a whole job on its own. I think I can fix this (tomorrow) but if not I'll just have to revert and there will be lots of redundancy in tests.yml again (which is what I was trying to eliminate)

choldgraf · 2023-01-26T17:54:45Z

just noting that I am seeing the string of commits and failed CI/CD above and offering you emotional support from France 😅

drammock · 2023-01-26T17:56:31Z

just noting that I am seeing the string of commits and failed CI/CD above and offering you emotional support from France sweat_smile

Thanks! I actually just got it working(ish). The build-docs jobs still fail because of a sphinx warning about not finding the logo file, but the weird char encoding error appears to be handled now.

choldgraf · 2023-01-26T17:58:19Z

amazing! now we just need to give @12rambau emotional support as he wrestles with Sphinx configuration overrides and callback functions in events :-D

12rambau

congrats on making it work 🍾

What is the rational for downgrading macOS and windows python versions from 3.9 to 3.8 ?

drammock · 2023-01-26T20:18:09Z

What is the rational for downgrading macOS and windows python versions from 3.9 to 3.8 ?

I was trying to deduplicate the file by using env variables, and use the same python version in all tests except the ones that use a python versions matrix. I first tried increasing the profile job to use 3.9 but it didn't work, so I changed them all to use 3.8. There's no strong reason they have to all use the same py version, but I'm a bit stubborn if you didn't notice already :)

Anyway I just had a new idea for deduplicating so I'll push another commit to try it. If it fails I'll just put all the versions back the way they started.

drammock · 2023-01-26T20:21:47Z

The workflow is not valid. .github/workflows/tests.yml: Anchors are not currently supported. Remove the anchor 'default_py'

that answers that :)

drammock · 2023-01-26T20:40:13Z

OK if this comes back all green then I think it's ready to merge. I ended up moving to 3.11 for all the non-pytest jobs, because I couldn't think of a rationale for picking any specific older version of python.

choldgraf

This looks great to me, and happy to see all of the succeeding jobs 🙂

I'd suggest that we merge this soon and see how it feels over the coming weeks in our ci/cd in case we need to spot check things.

Thanks @drammock for your effort here!

* Fix extra whitespace in sidebars (pydata#1115) * Fix extra whitespace in sidebars * Searchbox * Update src/pydata_sphinx_theme/__init__.py Co-authored-by: Daniel McCloy <dan@mccloy.info> * make test pass * Fix template filter to remove empty files * ABlog in template test * Move clear search button to primary sidebar * Move search clear button to top of article Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: Use logo_url instead deprecated logo in theme (pydata#1094) (pydata#1097) resolves pydata#1094 * ENH/MAINT: avoid overwriting the HtmlTranslator (pydata#1105) Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Fix pydata#143 Fix pydata#94 * fix: align sidebar sliding with the buttons (pydata#1123) * fix: aline the sidebar sliding with the buttons * build: force test to run on all platform if one platform is failing we cannot see if it's platform related as the other were closed * fix: use correct path for documentation logo * MAINT: Improve font sizing (pydata#1129) Fix pydata#1001 * MAINT: Refactor workflows to reduce test dependencies (pydata#1136) * MAINT: update prerelease workflow (pydata#1140) * ABlog: Updates for new HTML structure (pydata#1118) * ABlog: Updates for new HTML structure * Update templates for latest release * Bump to dev0 * Standardize logo image behavior between Sphinx and this theme (pydata#1132) Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * 0.13.0rc1 * Build(deps): Bump http-cache-semantics from 4.1.0 to 4.1.1 (pydata#1154) * DOC: Use only shield.io for badges in README (pydata#1152) * Copyright semicolon (pydata#1160) * FIX: Flex behavior should shrink header items instead of brand (pydata#1158) Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Fixes pydata#1143 * STYLE: lint the documentation with Doc8 (pydata#1150) Fix pydata#1139 * Add test for internationalization and translations (pydata#1138) * FIX: Javascript incorrect check for variable (pydata#1166) * MAINT: update pypi classifiers (pydata#1153) Fix pydata#1106 * remove emoji from landing page (pydata#1151) * add fa icons instead of emoji * remove fix for emojis * use markup for readme emojis * use pst-color-primary instead of sd-text-primary * make our semantic colors available as classes * try again --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: Narrow scope of style rule for GitHub & GitLab link shortening (pydata#1167) Fixes pydata#1156 * ENH: Add breadcrumbs to article header (pydata#1142) * ENH: Add breadcrumbs to article header * Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/breadcrumbs.html Co-authored-by: Tania Allard <taniar.allard@gmail.com> * More fixes * Improving nested page behavior * Documenting breadcrumbs * Update src/pydata_sphinx_theme/assets/styles/components/_breadcrumbs.scss Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Breacrumbs have link color --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Degrade gracefully when JavaScript is disabled (pydata#1146) * Fix header vertical spacing and jupyter-sphinx cells (pydata#1164) Fixes undefined * RLS: v0.13.0rc2 (pydata#1170) * DOCS: admonition customization (pydata#1155) * first draft of the admonition customization * typo in doc link * flesh out admon. customization example; DRY * use :code:rst instead of :literal: * Update docs/_static/custom.css --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Fix article header CSS (pydata#1171) * “Edit this page” → “Edit on GitHub/GitLab/Bitbucket” (pydata#1177) * “Edit this page” → “Edit on GitHub/GitLab/Bitbucket” Fixes pydata#1172 * Add tests * Fix typo * Properly handle default_mode=auto when writing logos (pydata#1183) We used to only defaulting to the light version when `default_mode` was undefined, not when it was explicitly set to `auto`. We also need to handle the latter, as the new test shows. Closes pydata#1180 Co-authored-by: Jérémy Bobbio (Lunar) <lunar@softwareheritage.org> * fix: correctly add DOM listeners (pydata#1179) fix adding DOM listeners * maint: update GitLab URL tests (pydata#1186) Co-authored-by: JoerivanEngelen <joerivanengelen@hotmail.com> * Standardize template structure in more sections (pydata#1184) * Standardize template structure in all sections * Fixing footer behavior * Update docs/user_guide/layout.rst Co-authored-by: Daniel McCloy <dan@mccloy.info> * Remove use of id= as much as possible --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * maint: remove sphinx-panels support; remove deprecated config shims (pydata#1188) * Minor style improvements to ablog (pydata#1185) * RLS: v0.13.0rc3 * dev0 * FIX: Some style bugs (pydata#1191) * FIX: Some style bugs * Move link word wrap to global rule * DOCS: Add internationalization instructions (pydata#1178) Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> * Refactor contributing docs to be more modular (pydata#1173) * Dev0 * Fix github gitlab brand (pydata#1194) * RLS: v0.13.0rc4 * FIX: Make wide equations scroll (pydata#1196) * Fix math scrollbars for realz (pydata#1198) * Fix math scrollbars for realz * Update src/pydata_sphinx_theme/assets/styles/content/_math.scss * Update src/pydata_sphinx_theme/assets/styles/content/_math.scss * copy_logo_images: do not render dynamic Sphinx template content (pydata#1204) * copy_logo_images: do not render dynamic Sphinx template content when copying logo image files * Update src/pydata_sphinx_theme/__init__.py --------- Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> * Add conditional check for last-updated template (pydata#1201) * Add conditional check for last-updated template * Whitespace * Properly set configuration with app.builder.theme_options (pydata#1199) * Properly set configuration * Dict to values * Making it explicit in a function * Better name * Fix test * Foot * Revert complex config set * Clarify docs * Use CSS transform for skip link (pydata#1206) * feat: Add full i18n support (pydata#1192) Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> * Dev0 * FIX: Remove icon links component when no icon links given (pydata#1209) * RLS: 0.13.0rc5 * dev0 * FIX: Get theme options in a more robust way (pydata#1214) * RLS: v0.13.0rc6 * Make heading-style use the font-weight-heading value (pydata#1213) * Make heading-style use the font-weight-heading value * Separate font-weight setting for content headers and admonitions * Flip var to be consistent with --pst-font-weight-heading instead * RLS: v0.13.0 * bump: dev0 * DOCS: Remove <p> from announcement sample text (pydata#1223) --------- Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Nico Albers <nico.albers@aboutyou.com> Co-authored-by: Chris Holdgraf <choldgraf@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Brendan Heberlein <bheberlein@wisc.edu> Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Lunar <lunar@debian.org> Co-authored-by: Jean Abou-Samra <jean@abou-samra.fr> Co-authored-by: Jérémy Bobbio (Lunar) <lunar@softwareheritage.org> Co-authored-by: JoerivanEngelen <joerivanengelen@hotmail.com> Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com> Co-authored-by: James Addison <55152140+jayaddison@users.noreply.github.com> Co-authored-by: Veronica Berglyd Olsen <1619840+vkbo@users.noreply.github.com>

drammock added 2 commits January 25, 2023 16:52

refactor workflows

8b31a4c

purge ablog from tests

54736c4

drammock force-pushed the workflow-tweaks branch 2 times, most recently from 29fb892 to 54736c4 Compare January 25, 2023 23:08

can't use workflow-level env vars at job level

62216e9

restore redundancy; DRY is not possible

9b7c763

drammock force-pushed the workflow-tweaks branch from 0baeaf6 to 9b7c763 Compare January 26, 2023 16:16

drammock added 7 commits January 26, 2023 10:31

fix?

73eb269

fix windows? (PYTHONUTF8=1)

1a19091

fix profile? (use py 3.8)

285024e

try setting PYTHONUTF8 var on windows

cad3728

try setting Encoding

e15ab30

try bash+PYTHONUTF8 on Windows

fd7832b

add PYTHONUTF8 fix to other windows job too

a5b8dd5

fix logo warning?

bf78ba3

12rambau approved these changes Jan 26, 2023

View reviewed changes

try YAML node anchors

275b51f

remove node anchors; use 3.11?

861f3ec

12rambau mentioned this pull request Jan 26, 2023

Standardize logo image behavior between Sphinx and this theme #1132

Merged

use matrix everywhere

4f2f93a

choldgraf approved these changes Jan 27, 2023

View reviewed changes

choldgraf changed the title ~~refactor workflows~~ MAINT: Refactor workflows to reduce test dependencies Jan 27, 2023

choldgraf merged commit 46ee983 into pydata:main Jan 27, 2023

drammock mentioned this pull request Jan 27, 2023

MAINT: update prerelease workflow #1140

Merged

drammock deleted the workflow-tweaks branch February 24, 2023 17:39

This was referenced Feb 24, 2023

create additional test without respecting restrictions on sphinx version of dependant packages #1099

Closed

ENH: split doc generation to avoid sphinx-design requiring nonnewest … #1113

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

MAINT: Refactor workflows to reduce test dependencies #1136

MAINT: Refactor workflows to reduce test dependencies #1136

drammock commented Jan 25, 2023

drammock commented Jan 26, 2023

choldgraf commented Jan 26, 2023

drammock commented Jan 26, 2023

choldgraf commented Jan 26, 2023

12rambau left a comment

drammock commented Jan 26, 2023

drammock commented Jan 26, 2023

drammock commented Jan 26, 2023

choldgraf left a comment

MAINT: Refactor workflows to reduce test dependencies #1136

MAINT: Refactor workflows to reduce test dependencies #1136

Conversation

drammock commented Jan 25, 2023

drammock commented Jan 26, 2023

choldgraf commented Jan 26, 2023

drammock commented Jan 26, 2023

choldgraf commented Jan 26, 2023

12rambau left a comment

Choose a reason for hiding this comment

drammock commented Jan 26, 2023

drammock commented Jan 26, 2023

drammock commented Jan 26, 2023

choldgraf left a comment

Choose a reason for hiding this comment