docs: update documentation about Maven registry support #1340
Conversation
|
|
||
| If instead you'd like to fetch data from [Maven Central](https://repo.maven.apache.org/maven2/), you can use the `--experimental-resolution-data-source=native` flag. | ||
|
|
||
| If your project uses mirrored or private registries, in addition to setting `--experimental-resolution-data-source=native`, you will need to use the `--experimental-maven-registry` flag to specify the registry. |
There was a problem hiding this comment.
| If your project uses mirrored or private registries, in addition to setting `--experimental-resolution-data-source=native`, you will need to use the `--experimental-maven-registry` flag to specify the registry. | |
| If your project uses mirrored or private registries, in addition to setting `--experimental-resolution-data-source=native`, you will need to use the `--experimental-maven-registry=<full-registry-url>` flag to specify the registry. |
Is this what you mean? Can you also add an example to clarify details like whether you need to include (https://) for example.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1340 +/- ##
==========================================
- Coverage 68.43% 68.41% -0.02%
==========================================
Files 183 183
Lines 17606 17606
==========================================
- Hits 12049 12046 -3
- Misses 4895 4897 +2
- Partials 662 663 +1 ☔ View full report in Codecov by Sentry. |
|
|
||
| If instead you'd like to fetch data from [Maven Central](https://repo.maven.apache.org/maven2/), you can use the `--experimental-resolution-data-source=native` flag. | ||
|
|
||
| If your project uses mirrored or private registries, in addition to setting `--experimental-resolution-data-source=native`, you will need to use the `--experimental-maven-registry=<full-registry-url>` flag to specify the registry (e.g. `--experimental-maven-registry=https://repo.maven.apache.org/maven2/`). |
There was a problem hiding this comment.
Unrelated to documentation, but should we name the flag --resolution-registry to be more generic? Or is it very specific to Maven?
There was a problem hiding this comment.
I have thought of this considering we will soon support transitive scanning for Python requirements.txt - ideally I would like to have something --resolution-registry=Maven:[URL],PyPI:[URL], but I don't have a very clear picture about how does Python private registry work so I don't want to put too much effort on finalizing this flag now, and this is also why I mark this flag as experimental. Also for the ecosystem string to be used in the flag, this should follow the spec that Gareth is working on which is also not finalized.
another-rex
changed the title
another-rex
changed the title
#1286 adds support for Maven registry during resolution.
As a follow up, this PR updates the documentation for transitive scanning about specifying data source during resolution as well as specifying Maven registry.
This PR also corrects the deps.dev API version we are using.
We also need to update the documentation in #1181.