Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DEV - Miscellaneous enhancements to CI #1928

Merged
merged 8 commits into from
Jul 15, 2024
Merged

DEV - Miscellaneous enhancements to CI #1928

merged 8 commits into from
Jul 15, 2024

Conversation

trallard
Copy link
Collaborator

@trallard trallard commented Jul 15, 2024 •
edited
Loading

This PR includes a couple of fixes to the CI workflows:

  • Moves the installation of Graphviz to our reusable setup action and uses third-party action
  • Ensures Graphviz is installed in the a11y tests
  • Adds a note about needing to install Graphviz to build our documentation
  • Re-adds CI permissions for the coverage action (that has led to fails in our scheduled CI https://github.com/pydata/pydata-sphinx-theme/actions/workflows/publish.yml)

@trallard trallard added tag: CI Pull requests that update GitHub Actions code tag: dependencies Pull requests that update a dependency file labels Jul 15, 2024
@trallard trallard marked this pull request as draft July 15, 2024 16:42
drammock
drammock reviewed Jul 15, 2024
View reviewed changes
Copy link
Collaborator

@drammock drammock left a comment

Choose a reason for hiding this comment

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

thanks for doing this! I was just about to refactor the graphviz installation in #1929, you saved me the trouble 😄

.github/actions/set-dev-env/action.yml Outdated Show resolved Hide resolved
.github/actions/set-dev-env/action.yml Outdated Show resolved Hide resolved
@trallard
Copy link
Collaborator Author

Ok graphviz action substituted, and it seems installs are working as expected so will mark as ready for review

@trallard trallard marked this pull request as ready for review July 15, 2024 17:44
trallard
trallard commented Jul 15, 2024
View reviewed changes
.github/actions/set-dev-env/action.yml
Comment on lines +13 to +16
graphviz:
description: Whether this should install Graphviz or not
required: false
default: "false"
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tried to change this to the GH actions boolean false and setting the type: boolean here but GH actions complained that this had to be a string 🤷🏽 not sure why so left it as a string for now

@github-actions GitHub Actions
Copy link

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)		Lines missing
  src/pydata_sphinx_theme
  __init__.py
  logo.py
  short_link.py
  toctree.py
  translator.py
Project Total  

This report was generated by python-coverage-comment-action

drammock
drammock approved these changes Jul 15, 2024
View reviewed changes
Copy link
Collaborator

@drammock drammock left a comment

Choose a reason for hiding this comment

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

LGTM and CIs are happy! Let's get this in.

@drammock drammock merged commit 477de81 into pydata:main Jul 15, 2024
29 checks passed
@trallard trallard deleted the trallard/ci-updates branch July 24, 2024 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@drammock drammock drammock approved these changes

Assignees
No one assigned
Labels
tag: CI Pull requests that update GitHub Actions code tag: dependencies Pull requests that update a dependency file
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@trallard @drammock