Skip to content

Do not build documentation in Circle CI, Read the Docs handles that 💯 #9788

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

Merged
merged 3 commits into from
Dec 13, 2022

Conversation

benjaoming
Copy link
Contributor

  • Removed tox entry in Circle CI configuration
  • Warnings will now propagate to failed builds on Read the Docs

I think we should also remove the tox configuration, no reason to maintain it unless someone uses it actively in their dev env? Our develop documentation doesn't mention it: https://dev.readthedocs.io/en/latest/docs.html

A side-note to this change: I think it's confusing that we had this build running. I kept wondering why - is there something that Read the Docs CI doesn't do?

@benjaoming benjaoming added the Improvement Minor improvement to code label Dec 8, 2022
@benjaoming benjaoming requested a review from a team as a code owner December 8, 2022 11:40
@benjaoming benjaoming requested a review from humitos December 8, 2022 11:40
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

I think this makes sense. Probably worth a note in the tox.ini saying that these 2 aren't run in CI, but are still there to be used locally?

@benjaoming
Copy link
Contributor Author

benjaoming commented Dec 8, 2022

Added the comment 👍

Wondering still if we need these tox environments, but I kind of like them because we have these custom environments for building the docs (PROJECT=user etc) and this is a nice manifestation for running them.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Seems the PR lost the actual changes to tox?

@benjaoming
Copy link
Contributor Author

You're right, I suspect a bad merge resolution in .circleci/config.yml - I redid the bad merge commit.

@humitos
Copy link
Member

humitos commented Dec 12, 2022

If we want to remove these checks from CircleCI, we have to make the Read the Docs CI checks Required by GitHub. Otherwise, we will be able to merge PR when docs are failing.
Screenshot_2022-12-12_13-15-07

@benjaoming
Copy link
Contributor Author

If we want to remove these checks from CircleCI, we have to make the Read the Docs CI checks Required by GitHub. Otherwise, we will be able to merge PR when docs are failing.

That's a really good idea! It can also help understand if this behavior is relevant to conditional build skipping, see: #9791

@ericholscher
Copy link
Member

It also looks like our RTD builds are not reporting properly on exit code failures (as seen in this PR), so we'd need to fix that before marking them required too 🙃

@benjaoming
Copy link
Contributor Author

benjaoming commented Dec 13, 2022

@ericholscher

It also looks like our RTD builds are not reporting properly on exit code failures (as seen in this PR), so we'd need to fix that before marking them required too 🙃

Could we defer this to #9791 ?

We are having yellow builds in this and other PR regardless of the Circle CI removal. However our docs builds do trigger when there are documentation changes. Since this PR doesn't have any documentation changes, the builds were skipped and never sent back a status (hence "yellow").

Meaning we can move forwards with this change but keeping in mind that we have some WIP on the RTD build skipping feature (if we don't manage to solve it quickly, we should disable build skipping and make the RTD builds required for PR merge)

@ericholscher
Copy link
Member

Right, I just think that having a known failing build be required makes PR's harder to use, and non-admins can't merge things I don't think. I'm fine if we want to remove the circleci docs stuff, and keep RTD unrequired, with a note to update that in #9791.

Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

I'm good with this, with a note that we should mark this required once we fix the reporting issue 👍

@benjaoming
Copy link
Contributor Author

Added as a note in #9791 👍

@benjaoming benjaoming merged commit f86b537 into readthedocs:main Dec 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants