docs: add per manager known list of issues

[Gabriel-Ladzaretti]

Changes

Context

Closes #15546

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[Gabriel-Ladzaretti]

Generated doc:

---

title: Automated Dependency Updates for Npm
sidebar_label: Npm

Renovate supports updating Npm dependencies.

File Matching

By default, Renovate will check any files matching the following regular expression: (^|/)package.json$.

For details on how to extend a manager's fileMatch value, please follow this link.

Supported datasources

This manager supports extracting the following datasources: github-tags, npm.

Additional Information

The following depTypes are currently supported by the npm manager :

• dependencies
• devDependencies
• optionalDependencies
• peerDependencies
• engines : Renovate will update any node, npm and yarn version specified under engines.
• volta : Renovate will update any node, npm and yarn version specified under volta.
• packageManager

??? note "Click me to see the list of open bug reports"

• Renovate removing dependencies in "unaffected" package in monorepo #12891
• Renovate cannot upgrade npm to an incompatible version when engine-strict=true is in .npmrc #12068
• Renovate doesn't update yarn.lock anymore with --install.frozen-lockfile true in .yarnrc #11356
• Invalid Yarn v1 lock file maintenance result #10331
• Renovate removed a or clause when updating node engines in package.json #7469
• Private dependencies are not updated #7354
• yarn lockfile update fails with skipInstalls and high trust #6443

??? note "Click me to see the list of upcoming features"

• Support node_modules that live in source control #13926
• Handle more complex yarn resolutions #12605
• Support npmv7 (lock file v2) for transitiveRemediation #10371
• Detect if npm package file is nodejs-only #9616
• Upgrade yarn when version policy is on #7429
• chore commit type when only the lockfile is updated #6791
• Add NPM Audit data to add more detail to Renovate PRs or limit to merge requests to only vulnerability fixes #6027
• Improve story for creating PRs to update to nightly builds #5872
• Update github hashes in npm package.json files #5640
• Semver-compatible branch committish incorrectly getting rolled back to tagged versions #5170
• npm: Add support for node compatibility checks #4826
• latest is not supported as a valid version spec for dependencies in a package.json file #3945
• Feature request: Rushjs monorepo support #3681
• feat(pnpm): support package.yaml and package.json5 #3653
• Vulnerability remediation using Yarn resolutions #3093
• Update dependencies to resolve security vulnerabilities in sub-dependencies #3080
• Feature Request: Add tag after bumpVersion and automerge #2928
• bumping the version doesn't execute npm preversion hook #2463
• Group remaining @types PR's #1799
• Suppress @types versions that are greater than companion package version #1372
• Special handling for npm @types #519

[rarkins]

Please sort by issue number so oldest go first.

And are we sure we want to collapse them? If so then I suggest we include the number of issues inside the summary/details (e.g. "5 open bug reports")

[HonkingGoose]

Please sort by issue number so oldest go first.

Agree.

And are we sure we want to collapse them? If so then I suggest we include the number of issues inside the summary/details (e.g. "5 open bug reports")

I like the idea to show the number of issues inside the admonition title.

[Gabriel-Ladzaretti]

If so then I suggest we include the number of issues inside the summary/details (e.g. "5 open bug reports")

here it is counted and sorted.

i just wonder, would showing features first be better?

---

title: Automated Dependency Updates for Npm
sidebar_label: Npm

Renovate supports updating Npm dependencies.

File Matching

By default, Renovate will check any files matching the following regular expression: (^|/)package.json$.

For details on how to extend a manager's fileMatch value, please follow this link.

Supported datasources

This manager supports extracting the following datasources: github-tags, npm.

Additional Information

The following depTypes are currently supported by the npm manager :

• dependencies
• devDependencies
• optionalDependencies
• peerDependencies
• engines : Renovate will update any node, npm and yarn version specified under engines.
• volta : Renovate will update any node, npm and yarn version specified under volta.
• packageManager

??? note "Click me to see the list of 8 open bug reports"

• yarn lockfile update fails with skipInstalls and high trust #6443
• Private dependencies are not updated #7354
• Renovate removed a or clause when updating node engines in package.json #7469
• Invalid Yarn v1 lock file maintenance result #10331
• Renovate doesn't update yarn.lock anymore with --install.frozen-lockfile true in .yarnrc #11356
• Renovate cannot upgrade npm to an incompatible version when engine-strict=true is in .npmrc #12068
• Renovate removing dependencies in "unaffected" package in monorepo #12891
• pnpmfile should not be ignored #15794

??? note "Click me to see the list of 21 upcoming features"

• Special handling for npm @types #519
• Suppress @types versions that are greater than companion package version #1372
• Group remaining @types PR's #1799
• bumping the version doesn't execute npm preversion hook #2463
• Feature Request: Add tag after bumpVersion and automerge #2928
• Update dependencies to resolve security vulnerabilities in sub-dependencies #3080
• Vulnerability remediation using Yarn resolutions #3093
• feat(pnpm): support package.yaml and package.json5 #3653
• Feature request: Rushjs monorepo support #3681
• latest is not supported as a valid version spec for dependencies in a package.json file #3945
• npm: Add support for node compatibility checks #4826
• Semver-compatible branch committish incorrectly getting rolled back to tagged versions #5170
• Update github hashes in npm package.json files #5640
• Improve story for creating PRs to update to nightly builds #5872
• Add NPM Audit data to add more detail to Renovate PRs or limit to merge requests to only vulnerability fixes #6027
• chore commit type when only the lockfile is updated #6791
• Upgrade yarn when version policy is on #7429
• Detect if npm package file is nodejs-only #9616
• Support npmv7 (lock file v2) for transitiveRemediation #10371
• Handle more complex yarn resolutions #12605
• Support node_modules that live in source control #13926

[rarkins]

Let's put feature requests first, then bugs.

And are we sure we want to collapse them? Are we doing that because we want to "hide" them for some reason, or because we think the page will be too long?

[betterPeleg]

Let's put feature requests first, then bugs.

And are we sure we want to collapse them? Are we doing that because we want to "hide" them for some reason, or because we think the page will be too long?

yes i also think not collapsing will be more functional.
if we will see that pages turn out to be too long we will re-consider

[betterPeleg]

@HonkingGoose
I want to add a comment at the bottom of the page stating something like:
“The lists of open bugs and feature requests are updated to the latest release at: (date)”
(mainly to be shown in exported docs when renovate is built)

do you know of a nice UI way to insert this note to the page? (and not just as plain text)

[HonkingGoose]

@HonkingGoose I want to add a comment at the bottom of the page stating something like: “The lists of open bugs and feature requests are updated to the latest release at: (date)” (mainly to be shown in exported docs when renovate is built)

do you know of a nice UI way to insert this note to the page? (and not just as plain text)

We can get Material for MkDocs to show the date the document was last updated at the bottom of each page. This feature requires a new dependency though.

And maybe the feature breaks for some pages, because we don't properly link all pages.
The mkdocs build step complains about missing pages in the nav in the mkdocs.yml config file.

So we definitely should test this on a preview server first. 😉

Material for MkDocs documentation, adding a revision date

The git-revision-date plugin adds support for displaying the date a document was last updated at the bottom of each page.

[rarkins]

do you know of a nice UI way to insert this note to the page? (and not just as plain text)

Maybe we can just include a prettified timestamp/date. e.g. "The above list of features and bugs were current at time of page generation on 27 May 2022".

[betterPeleg]

do you know of a nice UI way to insert this note to the page? (and not just as plain text)

Maybe we can just include a prettified timestamp/date. e.g. "The above list of features and bugs were current at time of page generation on 27 May 2022".

that sounds good to me.
add it as plain text in the bottom of the page?

[Gabriel-Ladzaretti]

---

title: Automated Dependency Updates for Cargo
sidebar_label: Cargo

Renovate supports updating Cargo dependencies.

File Matching

By default, Renovate will check any files matching the following regular expression: (^|/)Cargo.toml$.

For details on how to extend a manager's fileMatch value, please follow this link.

Supported datasources

This manager supports extracting the following datasources: crate.

Additional Information

Extracts dependencies from Cargo.toml files, and also updates Cargo.lock files too if found.

Upcoming features

• Support Rust/Cargo constraints when updating artifacts #6365

The above list of features were current at time of page generation on June 01, 2022.

[rarkins]

"Upcoming" may be a bit overselling it. Maybe "Related feature requests awaiting implementation" is more honest

[rarkins]

Can we see an updated mockup of how it looks?

[betterPeleg]

true
maybe "Pending feature requests"

[rarkins]

Or just "Open feature requests" and "Open bug reports"

[Gabriel-Ladzaretti]

---

title: Automated Dependency Updates for Maven
sidebar_label: Maven

Renovate supports updating Maven dependencies.

File Matching

By default, Renovate will check any files matching any of the following regular expressions:

(^|/|\.)pom\.xml$
^(((\.mvn)|(\.m2))/)?settings\.xml$

For details on how to extend a manager's fileMatch value, please follow this link.

Supported datasources

This manager supports extracting the following datasources: maven.

Additional Information

The maven manager focuses on extracting dependencies from pom.xml. It uses the official Maven versioning scheme.

Open feature requests

• Detect all Maven dependencies when upgrading property value #3247
• Maven: support for nested placeholders in properties #9043
• Maven: bumpVersion update child pom.xml versions in multi module projects #14703
• Maven: Update versions defined in a property but managed by parent pom #15170

Open bug reports

• Maven multi-module project handled incorrectly #6440
• Maven Updates Not Resolving Correct Position when running cross platform (windows with git bash) #6745
• defaultRegistryUrls does not work when the manager provides a custom defaultUrl #13925

The above list of features and bugs were current at time of page generation on June 02, 2022.

[rarkins]

@JamieMagee FYI we're going with displaying all features and bug reports now, instead of collapsing. Please see mockup above

[JamieMagee]

@JamieMagee FYI we're going with displaying all features and bug reports now, instead of collapsing. Please see mockup above

That's what I get for not reading the whole thread before replying 😅

[rarkins]

BTW this means we need to be diligent with (a) if/when to move from triage to non-triage priority, and (b) making sure issue titles accurately reflect their content. Our users sometimes create issues with alarmist titles like "npm doesn't work" and we need to make sure those are rewritten before they move out of triage.

[Gabriel-Ladzaretti]

Anything else to do here :?

[renovate-release]

🎉 This PR is included in version 32.79.0 🎉

The release is available on:

• GitHub release
• 32.79.0

Your semantic-release bot 📦🚀