Warn users if anything is written to old artifact directory #10036
Comments
ericholscher
changed the title
|
@agjohnson do you have an idea about how to show this warning? Currently, we don't support showing a warning message from the build. We only support showing an error. I'd say that probably the first step here is to |
|
@agjohnson also, do you have an example of a project outputting to |
We have changed the output directory from `_build/html` to `$READTHEDOCS_OUTPUT/html` in the last few weeks. However, there are some projects that may have `_build/html` directory hardcoded in different places (e.g. `conf.py`). We want to log these projects and contact them to communicate this situation. Ideally, we should show a warning in the build detail's page, but I don't think we currently have a way to display a warning message. We only support error messages in this page. Related #10036
We probably want an error, not a warning. Projects that are using a hardcoded path end up with docs missing lots of content right now. This is silent, and only noticeable if you open up your documentation and notice the missing content. A warning is only a small upgrade here, as it is still silent, and still requires the user to open up their documentation to find the missing content. So, a hard error makes the most sense here. I'd prefer setting |
I'd have to dig up the conversations in support, but anyone using Doxygen might be hitting this right now. Doxygen (and I assume Breathe?) seem to use a hardcoded path to output API docs. |
OK. I will do that then. Makes sense 👍🏼 |
* Build: log usage of old output directory `_build/html` We have changed the output directory from `_build/html` to `$READTHEDOCS_OUTPUT/html` in the last few weeks. However, there are some projects that may have `_build/html` directory hardcoded in different places (e.g. `conf.py`). We want to log these projects and contact them to communicate this situation. Ideally, we should show a warning in the build detail's page, but I don't think we currently have a way to display a warning message. We only support error messages in this page. Related #10036 * Build: use "test" command * Lint
|
With the logging changes through this morning, I think the volume of these errors is reasonable enough to fail any build outputting to Volume is low enough that I'm not worried about hotfixing this immediately, but if it ends up being a bit higher, we should consider that. Either way, we should target next release for a fix. |
|
It seems there is only one project in commercial so far: https://onenr.io/0OQMEqG19QG |
* Build: check for `_build/html` directory and fail if exists Continuation of #10038 Closes #10036 * Update exception message Co-authored-by: Anthony <[email protected]> --------- Co-authored-by: Anthony <[email protected]>
I think we've come across a few edge cases where the build output path changes have introduced bugs. We can probably expect more or perhaps a few fixes here.
Add warning if the old artifact path still exists, or a shim to copy that in with a warning for now.
This one will be partially solved by documentation too, though I'm guessing we probably want some error catching here, if a third party tool writes to
_build/htmletc.The text was updated successfully, but these errors were encountered: