-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
CI/DOC: Building the documentation with azure-pipelines #26648
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
CI/DOC: Building the documentation with azure-pipelines #26648
Conversation
Codecov Report
@@ Coverage Diff @@
## master #26648 +/- ##
==========================================
- Coverage 91.87% 91.87% -0.01%
==========================================
Files 174 174
Lines 50692 50692
==========================================
- Hits 46575 46571 -4
- Misses 4117 4121 +4
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #26648 +/- ##
==========================================
+ Coverage 91.71% 91.73% +0.01%
==========================================
Files 178 178
Lines 50740 50774 +34
==========================================
+ Hits 46538 46575 +37
+ Misses 4202 4199 -3
Continue to review full report at Codecov.
|
Ah, yes, indeed. Looking at the error message now, it is indeed a problem with the installation, not that it is not installed. |
I think the problem is that
Any idea on what is missing? |
I think it is related to the mentioned defaults/conda-forge mixing, but why conda is doing that, not sure .. |
I see, not sure why I'll make azure build with |
It's very weird, but the CI was green, and eventually it became red because instead of referencing its own build, was referencing a build of a different PR (https://travis-ci.org/pandas-dev/pandas/jobs/541912722). I rebased, hope this fix it, but mentioning here in case someone else sees the same, we should probably report the problem to github. |
The clipboard is not yet working, see here how I recently fixed it on Travis (https://github.com/pandas-dev/pandas/pull/26103/files), but no idea if something similar can fix it on appveyor (might actually also be a good question if the tests for this are working). |
Thanks @jorisvandenbossche I saw the warning, but thought it was one of the warnings that also happens in Travis. I opened #26700 to address it separately. No change should be required here. |
@@ -116,3 +116,65 @@ jobs: | |||
fi | |||
displayName: 'Running benchmarks' | |||
condition: true | |||
|
|||
- job: 'Docs' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can you make it so if this job fails it won't fail the entire build? just so we don't replicate the same problem as last time
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doesn't seem like pipelines has a feature like the travis one for allowed failures.
I can make the git push
step finish green even if it fails, I guess that's the closer option. But this time I set up the CI in my pandas fork, and made sure the part only executed after merging to master is able to push to dev.pandas.io, and it's working correctly.
Let me know if you want to be extra sure, but shouldn't happen the same as last time, the whole job is tested now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
right that's the part that could fail (as its only done on master); maybe not fail even if that fails
…ure of the build for testing)
@jreback made the changes so the CI is still green even if the push of the documentation from azure fails. Tested both that the push works, and that if it fails the CI stays green. Once merged, this will start updating dev.pandas.io with the master version of the docs. |
@jorisvandenbossche can you have a look here? I think would be good to get this merged some time before we activate the fail on warning in the docs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tiny question
azure-pipelines.yml
Outdated
timeoutInMinutes: 90 | ||
steps: | ||
- script: | | ||
echo '##vso[task.setvariable variable=CONDA_ENV]pandas-dev' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what is this used for? (I don't find it anywhere used in our CI config)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is used in ci/setup_env.sh
to create the conda environment. It's standard in all builds.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see any "CONDA_ENV" in https://github.com/pandas-dev/pandas/blob/master/ci/setup_env.sh, it seems this name is hardcoded everywhre (also in this yaml file a few lines below)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you're right, I think it was removed when ci/setup.sh
was refactored to be used everywhere and is not needed anymore.
|
||
- script: | | ||
cd doc/build/html | ||
git remote add origin [email protected]:pandas-dev/pandas-dev.github.io.git |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At some point you also had a pandas-dev-docs, that's removed again?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I started using that, but then I removed it. Using <organization-name>.github.io
we're able to use directly a custom domain dev.pandas.io
. Any other name of repo will make the url something like dev.pandas.io/pandas-dev-docs
. Personally I think it'll be very nice to have dev.pandas.io
, even more when we move to pandas.io
. After almost two years working in the docs I still don't remember the url of the travis docs. :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okido, I am not fully sure about the final url, but that's a discussion for later :-)
@jorisvandenbossche addressed your comments, CI is green |
OK, let's try again! :) |
thanks @jorisvandenbossche, CI is green, and docs where successfully built and pushed to http://dev.pandas.io/ :) |
git diff upstream/master -u -- "*.py" | flake8 --diff
Looks like the problem in #26591 was that the
HostName
input of the azure task that installs the key, is not the host name, but theknow_hosts
line for the host name where to push.I set up azure-pipelines in my pandas branch, to be able to see the
master
builds and avoid surprises, and this branch is successfully pushing the docs to https://dev.pandas.io@TomAugspurger since there were differences between the travis docs dependencies and
environment.yml
I think it makes more sense to change and useenvironment.yml
here, so we can detect and fix any problem while we still have the travis docs, and then simply remove the travis docs dependencies with the build when we are happy with this.@jorisvandenbossche the
ImportError
forpyarrow
doesn't seem to be becausepyarrow
is not inenvironment.yml
, it is. There is something weird with that, need to have a look.