SciML / SciML/EasyModelAnalysis.jl

QA fails after SciMLTesting 2.1 migration on rendered docs and reexports

Open
#314 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
87
Forks
14
Avg merge
21h 12m
Merged PRs (30d)
19

Description

Clean main currently fails its QA group independently of downgrade testing.

Reproduction:

GROUP=QA julia +1.10 --project=. -e 'using Pkg; Pkg.test()'\n```\n\nAt clean `main` `4e718b866ee7f671ef0b4e154aae1d15f54abfa2`, the run exits 1 with 17 passed / 2 failed / 1 broken. The failures are:\n\n- `LinearizationOpPoint` and `set_defaults` are public but not rendered in the docs.\n- 1,129 public reexports are not approved by QA.\n\nEquivalent before/after validation identifies `6624ad4` (PR #306, “Update SciMLTesting QA compat to 2.1”) as the introducing change: the preceding `7f541f5` QA setup resolves SciMLTesting 1.8 and passes 16 / 1 broken (exit 0), while `6624ad4` adds `api_docs_kwargs.rendered = true` and enables the stricter public-doc/reexport checks.\n\nThis is the same QA signature seen in PR #313; #313 only changes NLopt test compatibility and its downgrade job passes. Existing issue #300 concerns undefined exports and is distinct.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with GROUP=QA julia +1.10 --project=. -e 'using Pkg; Pkg.test()' and compare the QA behavior before and after commit 6624ad4. Inspect the api_docs_kwargs.rendered setting and the public-documentation and reexport checks. Done means the QA group passes on clean main, including the rendered LinearizationOpPoint and set_defaults entries and approved reexports.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation, testing
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.