Repository navigation
[CVE Remediation] Upgrade m2r2 to 2.1.0 to address mistune vulnerabilities - #396
Open
mjohanse-emr wants to merge 2 commits into
Open
mjohanse-emr wants to merge 2 commits into
mjohanse-emr wants to merge 2 commits into
Conversation
Signed-off-by: Michael Johansen <michael.johansen@emerson.com>
Signed-off-by: Michael Johansen <michael.johansen@emerson.com>
mjohanse-emr
requested review from
bkeryan,
dixonjoel and
jfriedri-ni
as code owners
October 8, 2026 20:30
Contributor
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The dependency updates are consistent, and the targeted documentation hook avoids the identified RST corruption.
0 open findings
What changed in this PR
Upgrades documentation tooling across the package suite to remediate Mistune vulnerabilities while preserving panel API documentation rendering.
Changes:
- Requires
m2r2>=2.1.0and locks Mistune 3.3.4. - Prevents m2r2 from reprocessing Napoleon-generated RST field lists.
| File | Description |
|---|---|
packages/ni.protobuf.types/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.protobuf.types/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.panels.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.panels.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.panels.v1.proto/docs/conf.py |
Protects Napoleon RST fields from m2r2 conversion. |
packages/ni.measurements.metadata.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurements.metadata.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurements.metadata.v1.client/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurements.metadata.v1.client/poetry.lock |
Refreshes documentation and local dependency locks. |
packages/ni.measurements.data.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurements.data.v1.proto/poetry.lock |
Refreshes documentation and local dependency locks. |
packages/ni.measurements.data.v1.client/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurements.data.v1.client/poetry.lock |
Refreshes documentation and local dependency locks. |
packages/ni.measurementlink.sessionmanagement.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.sessionmanagement.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.sessionmanagement.v1.client/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.sessionmanagement.v1.client/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.pinmap.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.pinmap.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.pinmap.v1.client/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.pinmap.v1.client/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.measurement.v2.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.measurement.v2.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.measurement.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.measurement.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.discovery.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.discovery.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.measurementlink.discovery.v1.client/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.measurementlink.discovery.v1.client/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.grpcdevice.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.grpcdevice.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.datamonikers.v1.proto/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.datamonikers.v1.proto/poetry.lock |
Locks upgraded documentation dependencies. |
packages/ni.datamonikers.v1.client/pyproject.toml |
Updates m2r2 requirement. |
packages/ni.datamonikers.v1.client/poetry.lock |
Refreshes documentation and local dependency locks. |
packages/ni-grpc-extensions/pyproject.toml |
Updates m2r2 requirement. |
packages/ni-grpc-extensions/poetry.lock |
Refreshes documentation and local dependency locks. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
bkeryan
requested changes
Oct 9, 2026
Collaborator
There was a problem hiding this comment.
As with urllib3, our distribution packages do not depend on m2r2 and changing pyproject.toml is not necessary. It's sufficient for Renovate to update poetry.lock:
Collaborator
There was a problem hiding this comment.
After upgrading to m2r2 2.1.0, I started getting warnings in the docs build for ni.panel.v1.proto related to poorly formatted field lists:
WARNING: Field list ends without a blank line; unexpected unindent. [docutils]
This warning is being returned because some :returns: fields were being corrupted by the m2r2 convert method. I updated the process_docstring method in that package to skip m2r2 formatting in cases where a docstring has already been processed by Napoleon into RST field lists.
If your fix for this works with the old m2r2 as well then it can be merged separately from the version update. Alternately, you can add your commit to Renovate's PR.
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this Pull Request accomplish?
Upgrades the
m2r2dependency to 2.1.0 or greater. This causes themistunerequirement to increase tomistune>=3.3,<3.4, which resolves many dependabot issues in this repo. Here's one example.After upgrading to
m2r22.1.0, I started getting warnings in the docs build forni.panel.v1.protorelated to poorly formatted field lists:This warning is being returned because some
:returns:fields were being corrupted by the m2r2convertmethod. I updated theprocess_docstringmethod in that package to skip m2r2 formatting in cases where a docstring has already been processed byNapoleoninto RST field lists.Why should this Pull Request be merged?
To remediate known vulnerabilities in older versions of
mistune.What testing has been done?
I did a quick scan of the resulting html files for
ni.panel.v1.protoand they look the same as the current contents on ReadTheDocs.