From 16d3a85579af889854dbdd3d2189a431ac6cabde Mon Sep 17 00:00:00 2001 From: Christopher Angelo Phillips <32073428+spiffcs@users.noreply.github.com> Date: Wed, 19 Jul 2023 12:54:18 -0400 Subject: [PATCH] docs: capture artifactory dev settings from 1895 (#1947) * docs: capture artifactory dev settings from 1895 --------- Signed-off-by: Christopher Phillips --- DEVELOPING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/DEVELOPING.md b/DEVELOPING.md index af13293f228..3d35f46075f 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -38,6 +38,26 @@ The main make tasks for common static analysis and testing are `lint`, `format`, See `make help` for all the current make tasks. +### Internal Artifactory Settings + +**Not always applicable** + +Some companies have Artifactory setup internally as a solution for sourcing secure dependencies. +If you're seeing an issue where the unit tests won't run because of the below error then this section might be relevant for your use case. + +``` +[ERROR] [ERROR] Some problems were encountered while processing the POMs +``` + +If you're dealing with an issue where the unit tests will not pull/build certain java fixtures check some of these settings: + +- a `settings.xml` file should be available to help you communicate with your internal artifactory deployment +- this can be moved to `syft/pkg/cataloger/java/test-fixtures/java-builds/example-jenkins-plugin/` to help build the unit test-fixtures +- you'll also want to modify the `build-example-jenkins-plugin.sh` to use `settings.xml` + +For more information on this setup and troubleshooting see [issue 1895](https://github.com/anchore/syft/issues/1895#issuecomment-1610085319) + + ## Architecture Syft is used to generate a Software Bill of Materials (SBOM) from different kinds of input.