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

add upper pin to jsonschema #1487

Merged
merged 1 commit into from
Mar 16, 2023

Conversation

braingram
Copy link
Contributor

jsonschema 4.18 will introduce changes that are incompatible with asdf. More details can be found in:
#1485

this commit adds an upper pin to jsoncschema and removes it from the devdeps testing

As described in the issue, adding a warning filter was insufficient to allow the devdeps jobs to pass.

An issue was created to track removing the pin: #1486

@github-actions github-actions bot added this to the 2.15.0 milestone Mar 15, 2023
Copy link
Contributor

@WilliamJamieson WilliamJamieson left a comment

Choose a reason for hiding this comment

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

I am normally against commenting things out instead of removing them.

In this case, I want it clearly documented why we have stopped the testing against jsonschema dev and why we have introduced an upper pin within the code itself. Otherwise, it becomes unclear when examining the code at first glance why these changes have been made and the intent for them to be temporary changes.

pyproject.toml Outdated Show resolved Hide resolved
requirements-dev.txt Show resolved Hide resolved
@WilliamJamieson
Copy link
Contributor

As described in the issue, adding a warning filter was insufficient to allow the devdeps jobs to pass.

Should an issue with jsonschema be opened about this? That clearly indicates the changes are not backwards compatible.

jsonschema 4.18 will introduce changes that are incompatible
with asdf. More details can be found in:
asdf-format#1485
this commit adds an upper pin to jsoncschema and removes
it from the devdeps testing
an issue was created to track removal of the pin:
asdf-format#1486
@braingram
Copy link
Contributor Author

Should an issue with jsonschema be opened about this? That clearly indicates the changes are not backwards compatible.

I am suspicious that something is up with the reference resolution in meta schemas but so far I've been unable to come up with a non-asdf minimal case that fails. Given the extensive use of non-public portions of jsonschema within asdf it's possible the changes did not introduce any public backwards incompatibility and the issues we're encountering are our own fault. I'd rather wait to open an issue until we can determine that jsonschema is at fault.

@braingram braingram marked this pull request as ready for review March 15, 2023 17:41
@braingram braingram requested a review from a team as a code owner March 15, 2023 17:41
Copy link
Contributor

@WilliamJamieson WilliamJamieson left a comment

Choose a reason for hiding this comment

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

Hopefully these changes will be temporary

@pllim
Copy link
Contributor

pllim commented Mar 17, 2023

I vaguely remember a maxversion pin of jsonschema in the past, and eventually that gave astropy problems when something else required a new jsonschema that asdf cannot use. So hopefully this won't stay forever. 🤞

@WilliamJamieson
Copy link
Contributor

@meeseeksdev backport to 2.14.x

@lumberbot-app
Copy link

lumberbot-app bot commented Mar 17, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout 2.14.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 b8e1759aa9f013283942140c94732a170eb9a703
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #1487: add upper pin to jsonschema'
  1. Push to a named branch:
git push YOURFORK 2.14.x:auto-backport-of-pr-1487-on-2.14.x
  1. Create a PR against branch 2.14.x, I would have named this PR:

"Backport PR #1487 on branch 2.14.x (add upper pin to jsonschema)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

WilliamJamieson added a commit to WilliamJamieson/asdf that referenced this pull request Mar 17, 2023
WilliamJamieson added a commit to WilliamJamieson/asdf that referenced this pull request Mar 17, 2023
WilliamJamieson added a commit to WilliamJamieson/asdf that referenced this pull request Mar 17, 2023
@braingram braingram deleted the jsonschema_pin branch March 21, 2023 17:08
@github-actions github-actions bot modified the milestones: 2.15.0, 2.15.1 Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants