Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Go support for Curation documentation. #147

Merged
merged 4 commits into from
Aug 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions jfrog-applications/jfrog-cli/cli-for-jfrog-curation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,20 @@

JFrog Curation defends your software supply chain, enabling early blocking of malicious or risky open-source packages before they even enter. Seamlessly identify harmful, vulnerable, or risky packages, ensuring increased security, compliance, and developer productivity.

For more information see: https://jfrog.com/curation/
For more information see [**here**](https://jfrog.com/curation/)

The 'curation-audit' is a JFrog CLI command designed for developers to scan their projects and identify third-party dependencies that violate the restrictions set by the Curation service. This command provides detailed insights into the specific package policies that are being violated, leading to their blockage by the Curation service. Additionally, when feasible, 'curation-audit' may suggest alternative versions of the packages that comply with the Curation policies.

## Supported package managers & build systems

For a full list of the package managers and build systems supported by the curation-audit command and the required Artifactory and Xray versions to use it please see: https://jfrog.com/help/r/jfrog-curation/curation-support-matrix

curation-audit command supported package managers and build systems:
Curation-audit command supported package managers and build systems:

* Npm (npm)
* Maven (mvn) - Requires xray 3.92 and above, and Artifactory 7.82 and above
* Pip (pip) - Requires xray 3.92 and above, and Artifactory 7.82 and above
* Go (go) - Requires xray 3.92 and above, and Artifactory 7.87 and above

For a full list of the package managers and build systems supported by the curation-audit command and the required Artifactory and Xray versions to use it please see [**this matrix**](https://jfrog.com/help/r/jfrog-curation/curation-support-matrix)

***

Expand All @@ -28,7 +29,9 @@ Audit your Project with JFrog CLI curation-audit command

Prerequisites:

Make sure your JFrog Artifactory admin configured the curated remote repository you are using during your build process. For more information refer your Artifactory admin to: https://jfrog.com/help/r/jfrog-curation/configure-curation-pass-through
Make sure your JFrog Artifactory admin configured the curated remote repository you are using during your build process. For more information refer your Artifactory admin to [**this page**](https://jfrog.com/help/r/jfrog-curation/configure-curation-pass-through)
</br></br>**Note**: Some package types require 'pass-through' curation configuration on the remote repositories in Artifactory, in addition to configuring curation on them.


1. **Connect JFrog CLI to JFrog Platform**

Expand All @@ -44,8 +47,8 @@ Make sure your JFrog Artifactory admin configured the curated remote repository
jf c show
```

* It should present Artifactory server just added (with default true)\
\
* It should present Artifactory server just added (with default true)


2. **Configure JFrog CLI for Project**\
Ensure your project is configured in the JFrog CLI with the repository you would like to resolve dependencies from. Here are details for each package manager:
Expand All @@ -55,6 +58,8 @@ Make sure your JFrog Artifactory admin configured the curated remote repository
* Set the resolved repository using the [**jf mvnc**](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration#setting-maven-repositories) command inside the project directory.
* **PIP:**
* Set the resolved repository using the [**jf pipc**](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration#setting-python-repository) command inside the project directory (The only package installer supported for now by Python is "pip").
* **GO:**
* Set the resolved repository using the [**jf goc**](https://docs.jfrog-applications.jfrog.io/jfrog-applications/jfrog-cli/cli-for-jfrog-artifactory/package-managers-integration#examples-4) command inside the project directory.

#### Commands Params

Expand Down
Loading