ReadTheDocs autodetection can be a small footgun for non-RTD builds / make_tag raises exceptions when ogp_site_url is None
#87
Comments
Julian
added a commit
to python-jsonschema/jsonschema
that referenced
this issue
Nov 22, 2022
Julian
added a commit
to bowtie-json-schema/bowtie
that referenced
this issue
Nov 22, 2022
|
Sorry, there's an open PR for this issue I've forgotten about. I'll see to that. |
|
No need at all for apologies! I saw that PR and wasn't 100% sure it was meant to address this specifically, but yeah thanks for the response and having a look! |
|
v0.7.3 has been released and should fix your issue. |
|
Amazing, thank you! Indeed seems to. |
clrpackages
pushed a commit
to clearlinux-pkgs/pypi-jsonschema
that referenced
this issue
Dec 28, 2022
…version 4.17.3
Julian Berman (28):
Make it clearer that format: regex is Python regexes in this implementation.
Better wording.
Bold is loud.
Ignore PyCQA/flake8-bugbear#287.
Fix the grammar on ErrorTree's repr when it has 1 error.
Deprecate the CLI (via import or running normally).
Update the Draft 3 and 4 metaschemas.
Enable format validation by default in check_schema.
Re-add the second test for importing jsonschema.cli
Satisfy mypy's new default.
Squashed 'json/' changes from ed0b855e7..0fa89d2ab
Squashed 'json/' changes from 0fa89d2ab..9251ebff1
Emit a better error message for unevaluatedProperties with a subschema.
Un-bundle single-vocabulary meta-schemas.
Update docs requirements.
Temporarily evade wpilibsuite/sphinxext-opengraph#87
Suppress epub warnings for duplicated ToC entries.
Run more things with 3.11 in CI.
Skip the rest of the docs builds on Windows in CI.
Remove making believe we are ReadTheDocs in CI builds.
v4.17.1 -> CHANGELOG
Squashed 'json/' changes from 9251ebff1..78c888273
Minor fix for test case class names (for format tests).
Empty strings are not valid relative JSON pointers.
Durations without trailing units aren't valid durations.
Update pre-commit hooks.
Try fixing more Sphinx refs which fail only on Ubuntu...
Fix instantiating validators with cached refs-to-bool schemas.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
(Hello! Thanks for the library!)
I've recently began to notice CI
dirhtmlbuilds which use sphinxext.opengraph fail after bumping dependencies. The kinds of errors (across projects) look like:where there's
replacebeing called onNonerather than astr.Some minor debugging showed that what's happening is that autodetection of the
READTHEDOCSenvironment variable obviously doesn't work when the build is running in CI (or in tox locally), soogp_site_urlends up beingNone, whichmake_tagwon't like very much.I didn't track down what changed if anything (either here or in other deps) -- I'm happy to do so if that's helpful, as I've definitely successfully used this library before, but it seems that things are a bit awkward if one relies entirely on the ReadTheDocs autodetection, so I thought I'd file this anyhow. Specifically I of course want my site URL autodetected, and "real" doc builds will run in RTD. But it seems without manually specifying
ogp_site_url, I can't actually test doc builds.Concrete suggestions (possibly not all needed) in case that's helpful (and I'm sure I may be missing even better ones):
dirhtmlexternallyNoneinmake_tagor in the frame above it (and do some nonsense thing, since that may be better than jjust blowing up)ogp_site_urljust for this case (CI for builds) in a way that the value isn't "in danger" of being used, but where it's still usable during CI builds (e.g. via an envvar which is used only when READTHEDOCS is not set or something)(Again I may have missed something, so apologies for any errors! And thanks again)
The text was updated successfully, but these errors were encountered: