Page MenuHomeSoftware Heritage

Fix swh-docs's broken dev build
Closed, ResolvedPublic

Description

Build [1] has been broken for days, probably more.

WARNING: autodoc: failed to import module 'setup' from module 'swh.loader.cvs.rcsparse'; the following exception was raised:
No module named 'swh.loader.cvs.rcsparse.setup'; 'swh.loader.cvs.rcsparse' is not a package
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/swh-loader.rst:6: WARNING: duplicated entry found in toctree: swh-loader-cvs/index
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/apidoc/swh.loader.cvs.rcsparse.setup.rst: WARNING: document isn't included in any toctree
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/swh-perfecthash/index.rst: WARNING: document isn't included in any toctree
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/swh-vault/getting-started.rst:24: WARNING: undefined label: persistent-identifier

[1] https://jenkins.softwareheritage.org/job/DDOC/job/dev/6791/console

Event Timeline

ardumont triaged this task as Normal priority.Tue, Oct 12, 9:44 AM
ardumont created this task.

/me *sigh* it's still red...

That really should be a team effort, to strive to keep our builds green.
So for this build, i concur with @anlambert, we should make it build during diff.

15:14 <+anlambert> ardumont: in order to catch sphinx issues in swh-docs, I was thinking of running the swh-docs/dev Jenkins job when submitting a diff to swh-docs. I think we only need to setup a new harbomaster build plan for that (https://forge.softwareheritage.org/harbormaster/plan/).
15:14 <+ardumont> anlambert: yes, that'd be good because i'm still on T3648 and that's really frustrating

@anlambert thx for the suggestion ^

/me *sigh* it's still red...

That really should be a team effort, to strive to keep our builds green.
So for this build, i concur with @anlambert, we should make it build during diff.

15:14 <+anlambert> ardumont: in order to catch sphinx issues in swh-docs, I was thinking of running the swh-docs/dev Jenkins job when submitting a diff to swh-docs. I think we only need to setup a new harbomaster build plan for that (https://forge.softwareheritage.org/harbormaster/plan/).
15:14 <+ardumont> anlambert: yes, that'd be good because i'm still on T3648 and that's really frustrating

@anlambert thx for the suggestion ^

Looks like the only remaining warning is the following: WARNING: A mocked object is detected: 'swh.loader.cvs.rcsparse'.

Regarding setting up a CI build for the dev documentation when submitting diffs to swh-docs, thinking it back some adaptations
will also be needed in the Jenkins jobs configuration for swh-docs/dev in order to add some parameters (diff id, ...) and communicate Jenkins
job links and test results back to Phabricator.

I think we should also trigger the swh-docs/publish Jenkins job when pushing changes to master.

Looks like the only remaining warning is the following: WARNING: A mocked object is
detected: 'swh.loader.cvs.rcsparse'.

Yes, and that's because there are some mock setup about it. I tentatively prevented that
module swh.loader.cvs.rcsparse to build because being "autodoc" detected, it creates
other problems on its own (that's one of the initial problem inlined in the
description).

I don't know what the proper fix for that module is. It's installed within the
swh.loader.cvs module but it has its own swh.loader.cvs.rcparse module (with setup.py).

Regarding setting up a CI build for the dev documentation when submitting diffs to
swh-docs, thinking it back some adaptations will also be needed in the Jenkins jobs
configuration for swh-docs/dev in order to add some parameters (diff id, ...) and
communicate Jenkins job links and test results back to Phabricator.

probably

I think we should also trigger the swh-docs/publish Jenkins job when pushing changes
to master.

That might be quite a lot especially on period where we tend to push a lot of docs. But
maybe, we can for that build, only trigger that publish step on the head commit. I
guess, we'll have to see how that goes to decide.

Note that activating that build on diff will take some time...
I mean the build sphinx-dev takes a long time to finish.

ardumont claimed this task.

It's finally green! Closing this.

I've created the task about activating the build on docs diff in T3661.

[1] https://jenkins.softwareheritage.org/job/DDOC/job/dev/6823/console