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

Define a process to test the readthedocs CI before merging into master #3369

Closed
crusaderky opened this issue Oct 3, 2019 · 3 comments · Fixed by #3714
Closed

Define a process to test the readthedocs CI before merging into master #3369

crusaderky opened this issue Oct 3, 2019 · 3 comments · Fixed by #3714
Labels
CI Continuous Integration tools topic-documentation

Comments

@crusaderky
Copy link
Contributor

crusaderky commented Oct 3, 2019

This is an offshoot of #3358.

The readthedocs CI has a bad habit of failing even after the Azure Pipelines job "Docs" has succeeded.

After major changes that impact the documentation, and before merging everything into master, it would be advisable to explicitly verify that RTD builds correctly.

So far I tried to

  1. create my own readthedocs project, https://readthedocs.org/projects/crusaderky-xarray/
  2. point it to my fork https://github.com/crusaderky/xarray/
  3. enable build for the branch I want to merge

This is currently failing because of an issue with versioneer, which incorrectly sets xarray.__version__ to 0+untagged.111.g6d60700.
This in turn causes a failure in a minimum version check in pandas.DataFrame.to_xarray() on pandas>=0.25.

In the master RTD project https://readthedocs.org/projects/xray/, I can instead read xarray: 0.13.0+20.gdd2b803a.

So far the only workaround I could find was to downgrade pandas to 0.24 in ci/requirements/doc.yml.

@crusaderky crusaderky changed the title versioneer broken in readthedocs CI Define a process to test the readthedocs CI before merging into master Oct 3, 2019
@dcherian
Copy link
Contributor

dcherian commented Oct 3, 2019

Maybe switch away from versioneer? #2853

@crusaderky crusaderky added topic-documentation CI Continuous Integration tools labels Oct 3, 2019
@max-sixty
Copy link
Collaborator

We've had success with setuptools_scm internally, though not without any issues—in particular it has to be built in a git repo. Assuming that's the case, it requires very little maintainence.

Anything I'm missing? I haven't used it in an OSS project

@dcherian dcherian mentioned this issue Nov 20, 2019
1 task
This was referenced Nov 20, 2019
@crusaderky crusaderky mentioned this issue Jan 21, 2020
3 tasks
@crusaderky
Copy link
Contributor Author

I've been using setuptools-scm in multiple other projects and it's great!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration tools topic-documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants