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.

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

Fix docs build #5492

Merged
merged 3 commits into from
Oct 31, 2024
Merged

Fix docs build #5492

merged 3 commits into from
Oct 31, 2024

Conversation

snejus
Copy link
Member

@snejus snejus commented Oct 30, 2024

Description

Seems like readthedocs build expects docs dependencies to be available
as an extra, see one of the failing builds: https://app.readthedocs.org/projects/beets/builds/26079213/.

You can see this has been failing due to missing 'pydata_sphinx_theme' which is one of our dependencies:

    raise ThemeError(__('no theme named %r found (missing theme.toml?)') % name)
    sphinx.errors.ThemeError: no theme named 'pydata_sphinx_theme' found (missing theme.toml?)
    Theme error:
    no theme named 'pydata_sphinx_theme' found (missing theme.toml?)

Seems like readthedocs build expects docs dependencies to be available
as an extra, see one of the failing builds: https://app.readthedocs.org/projects/beets/builds/26079213/.

You can see this has been failing due to missing 'pydata_sphinx_theme':

    raise ThemeError(__('no theme named %r found (missing theme.toml?)') % name)
    sphinx.errors.ThemeError: no theme named 'pydata_sphinx_theme' found (missing theme.toml?)
    Theme error:
    no theme named 'pydata_sphinx_theme' found (missing theme.toml?)
@snejus snejus self-assigned this Oct 30, 2024
These seem to have managed to escape the CI checks since the previously
merged PR was based on master commit which did not include the checks.
@snejus snejus force-pushed the fix-docs-build branch 2 times, most recently from e5b6aa6 to 07529cb Compare October 30, 2024 12:24
This was a very bad idea since this made CI operate within the context
of the *base* branch, which meant that the tests were testing code in
the `master` branch instead of the branch that was to be merged!
@snejus
Copy link
Member Author

snejus commented Oct 30, 2024

The two failing checks are from the workflow that used pull_request_target trigger. As you can see they are failing even when the code has been fixed, because they are checking the code on master.

Thus the last commit reverts the commit that introduced pull_request_target to fix coverage uploads from forks. We will find another way to fix that issue.

Copy link
Contributor

@Serene-Arc Serene-Arc left a comment

Choose a reason for hiding this comment

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

lgtm, merge when you're ready

@snejus snejus merged commit fa10dcf into master Oct 31, 2024
23 of 25 checks passed
@snejus snejus deleted the fix-docs-build branch October 31, 2024 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants