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

Fix overview.md file #419

Merged
merged 38 commits into from
May 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
5f3c773
unify
sverdlov93 May 1, 2023
268d945
unify
sverdlov93 May 1, 2023
86dc972
unify
sverdlov93 May 1, 2023
1c3bad4
unify
sverdlov93 May 7, 2023
6d2976a
Merge branch 'dev' of https://github.com/jfrog/artifactory-azure-devo…
sverdlov93 May 9, 2023
97ef5e3
unify
sverdlov93 May 9, 2023
735bc00
Merge branch 'dev' of https://github.com/jfrog/artifactory-azure-devo…
sverdlov93 May 10, 2023
5e6e1e1
Merge branch 'dev' of https://github.com/jfrog/artifactory-azure-devo…
sverdlov93 May 10, 2023
f4cee53
unify
sverdlov93 May 10, 2023
209d8c7
unify
sverdlov93 May 16, 2023
9622621
unify
sverdlov93 May 16, 2023
655f75c
unify
sverdlov93 May 16, 2023
de6ecbe
unify
sverdlov93 May 16, 2023
92873b0
unify
sverdlov93 May 16, 2023
9ce17fa
unify
sverdlov93 May 16, 2023
38ada2b
unify
sverdlov93 May 16, 2023
078d428
unify
sverdlov93 May 16, 2023
d821171
unify
sverdlov93 May 16, 2023
26ae504
unify
sverdlov93 May 16, 2023
9caa970
unify
sverdlov93 May 16, 2023
88085ed
unify
sverdlov93 May 16, 2023
054f162
unify
sverdlov93 May 16, 2023
5334b4a
unify
sverdlov93 May 16, 2023
3ccd957
unify
sverdlov93 May 16, 2023
230bf85
unify
sverdlov93 May 16, 2023
4c4e5f9
unify
sverdlov93 May 16, 2023
dc331e3
unify
sverdlov93 May 16, 2023
7989cf3
unify
sverdlov93 May 16, 2023
e762754
unify
sverdlov93 May 16, 2023
b320b57
unify
sverdlov93 May 17, 2023
3f893a3
unify
sverdlov93 May 17, 2023
a5d921d
unify
sverdlov93 May 17, 2023
8486c5e
unify
sverdlov93 May 17, 2023
fa29ced
unify
sverdlov93 May 17, 2023
54036ed
unify
sverdlov93 May 18, 2023
fd790fe
Merge branch 'dev' of https://github.com/jfrog/artifactory-azure-devo…
sverdlov93 May 18, 2023
6d56d56
Merge branch 'dev' of https://github.com/jfrog/artifactory-azure-devo…
sverdlov93 May 18, 2023
3930c58
unify
sverdlov93 May 18, 2023
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
155 changes: 155 additions & 0 deletions overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
[![](images/introduction.png)](https://github.com/jfrog/jfrog-azure-devops-extension)

## Overview
The **JFrog Platform** is a leading universal end-to-end DevOps platform for automating, managing, securing, distributing, orchestrating, monitoring, and optimizing your Cl/ CD pipeline.

[Learn more](https://jfrog.com/)

**JFrog Platform** provides tight integration with Azure DevOps through the **JFrog Extension.**
In addition to managing efficient deployment of your artifacts to Artifactory,
the extension lets you capture information about your build's resolved dependencies and deployed artifacts.
Gain full traceability for your builds as the environment data associated with your build is automatically collected.

[Learn more](https://jfrog.com/artifactory/)

The extension currently supports the following package managers:
Maven, Gradle, Go, npm, NuGet, .NET Core, Pip and Conan. It also allows downloading and uploading generic files from and to Artifactory, and perform generic tasks on artifacts on Artifactory.

**JFrog Xray** is an application security tool that integrates security directly into your DevOps workflows, enabling you to deliver trusted software releases faster.

[Learn more](https://jfrog.com/xray/)

The extension supports triggering a scan on a published build in Artifactory, or auditing a local project from sources.

**JFrog Distribution** is a centralized platform that lets you provision software release distribution.

[Learn more](https://jfrog.com/distribution/)

The **JFrog Extension** also allows managing Release Bundles and their distribution processes, including release content, and target destinations.

## Documentation and source code
The full extension documentation is available [here](https://github.com/jfrog/jfrog-azure-devops-extension#readme).
<br>
See the source code is on [GitHub](https://github.com/jfrog/jfrog-azure-devops-extension).

## Generic artifacts handling
The **JFrog Generic Artifacts** task allows performing generic actions on artifacts, such as:
1. Downloading and uploading from/to Artifactory
2. Setting or deleting properties on artifacts in Artifactory
3. Moving, copying and deleting artifacts in Artifactory

### Downloading generic build dependencies from Artifactory
The task supports downloading your build dependencies from Artifactory to the build agent.
The downloaded dependencies are defined using [File Specs](https://jfrog.com/help/r/jfrog-integrations-documentation/using-file-specs)
and can be also configured to capture the build-info.
It will store the downloaded files as dependencies in the build-info which can later be published to Artifactory using the **JFrog Publish Build-Info** task.

![GenericDownload](images/marketplace/generic-download.png)

### Uploading generic build artifacts to Artifactory
The task also supports uploading your generated build artifacts from the build agent's local file system to Artifactory.
The artifacts are defined using [File Specs](https://jfrog.com/help/r/jfrog-integrations-documentation/using-file-specs).
The task can be also configured to capture build-info and stores the uploaded files as artifacts in the build-info. The captured build-info can be later published to Artifactory using the **JFrog Publish Build-Info** task.

![GenericUpload](images/marketplace/generic-upload.png)

### Setting / Deleting properties on files in Artifactory
The JFrog Generic Artifacts task also allows both setting and deleting properties on artifacts in Artifactory.

![Props](images/marketplace/props.png)

### Moving / Copying / Deleting artifacts in Artifactory
Same task also allows performing generic actions on artifacts in Artifactory.

![Copy](images/marketplace/move-copy-delete.png)

## Triggering NuGet, .NET Core CLI, Maven, Gradle, npm, Go, Pip and Conan builds
The extension adds the following tasks - **JFrog NuGet**, **JFrog .NET Core**, **JFrog Maven**, **JFrog Gradle**, **JFrog npm**, **JFrog Go**, **JFrog Pip** and **JFrog Conan** to support full build integration with Artifactory.

All tasks allow resolving dependencies and deploying artifacts from and to Artifactory.

These tasks can also be configured to capture build-info for the build. The captured build-info can be later published to Artifactory using the **JFrog Publish Build-Info** task.

![nuget](images/marketplace/nuget.png)
![dotnet](images/marketplace/dotnet.png)
![mvn](images/marketplace/mvn.png)
![gradle](images/marketplace/gradle.png)
![npm](images/marketplace/npm.png)
![go](images/marketplace/go.png)
![pip](images/marketplace/pip.png)
![conan](images/marketplace/conan.png)

## Scanning builds with JFrog Xray
The JFrog Extension integrates with JFrog Xray, allowing you to have build artifacts scanned for vulnerabilities and other issues using the **JFrog Build Scan** task.
If issues or vulnerabilities are found, you may choose to fail the build.

![BuildScan](images/marketplace/build-scan.png)
![Table](images/marketplace/violations-table.png)

## Auditing projects for security vulnerabilities
Using the **JFrog Audit** task, you can trigger a scan on your local project. The task will automatically detect the used package-manager to perform audit with integration with JFrog Xray.
By default, the results will include all vulnerabilities found. You may however configure the task to show only violations configured in Xray.

![Audit](images/marketplace/audit.png)

## Pushing and Pulling Docker Images to and from Artifactory
The **JFrog Docker** task allows pushing and pulling docker images to and from a docker repository in Artifactory.
The task can be also configured to capture build-info for the pushed or pulled image.
In addition to details about the build and the build environment, the build info includes the image layers as build dependencies and build artifacts.

![Docker](images/marketplace/docker-pull.png)

## Scanning Local Docker Images with JFrog Xray
The **JFrog Docker** task allows scanning local docker images using JFrog Xray. The scan results are displayed in the build log.
By default, the results will include all vulnerabilities found. You may however configure the task to show only violations configured in Xray.

![Docker](images/marketplace/docker-scan.png)

## Recording tracked issues
Being able to look at the build which was published to Artifactory, and see all the tracked issues (from JIRA for example) associated with it, is one of the most powerful capabilities of Artifactory when it comes to managing metadata about builds. The **JFrog Collect Issues** task can automatically identify the issues handled in the current build, and record them as part of the build-info. Read more about this unique capability [here](https://www.jfrog.com/confluence/display/JFROG/JFrog+Azure+DevOps+Extension#JFrogAzureDevOpsExtension-CollectingBuildIssues).

## Publishing build-info
Build-info captured in preceding tasks can be published to Artifactory using the **JFrog Publish Build-Info** task.
The configured build name & number, and the optional project key, should match the ones specified when the build-info was captured.

![BuildPublish](images/marketplace/build-publish.png)

## Promoting published builds
Artifactory supports promoting published builds from one repository to another,
to support the artifacts life-cycle.
The **JFrog Promotion** task promotes a build, by either copying or moving the build artifacts and/or dependencies to a target repository.
This task can be added as part of a Release pipeline, to support the release process.

![BuildPromotion](images/marketplace/build-promotion.png)

## Discarding published builds
The **JFrog Discard Builds** task is used to discard previously published builds from Artifactory.
Builds are discarded according to the retention parameters configured in the task.

![Discard](images/marketplace/discard.png)

## Executing JFrog CLI commands
The **JFrog CLI V2** task allows executing [JFrog CLI](https://jfrog.com/help/r/jfrog-cli/jfrog-cli) commands, while using the pre-configured connection details of JFrog Platform, stored in Azure DevOps.

## Accessing the Build-Info
You can access the build-info from the Build Results in Azure DevOps, if your build pipeline has published the build-info to Artifactory.

![BuildResults](images/marketplace/build-results.png)
![BuildInfo](images/marketplace/bi-in-artifactory.png)

## Releasing published builds
The **JFrog Publish Build-Info** task allows publishing builds to Artifactory. By choosing Artifactory as an artifacts source in a Release,
you can select a published build, to make its artifacts available for the release.

![ArtifactsSource](images/marketplace/artifacts-source.png)

## Managing binaries distribution
The **JFrog Distribution** task allows managing release bundles.
The task provides the capability to create, update, sign, distribute or delete release bundles from JFrog Distribution.

![Distribution](images/marketplace/distribution.png)

## Behind the scenes
Most tasks trigger the [JFrog CLI](https://jfrog.com/help/r/jfrog-cli/jfrog-cli) to perform the requested actions.
The extension handles downloading and caching the JFrog CLI, which is done once per pipeline.
You can configure the used JFrog CLI version, and configure to download it from your Artifactory instance using the **JFrog Tools Installer** task.
4 changes: 2 additions & 2 deletions vss-extension.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
],
"content": {
"details": {
"path": "README.md"
"path": "overview.md"
},
"license": {
"path": "LICENSE.md"
Expand All @@ -47,7 +47,7 @@
"uri": "https://jfrog.com/help/r/get-started-with-the-jfrog-platform/get-started"
},
"learn": {
"uri": "https://github.com/jfrog/jfrog-azure-devops-extension/blob/v2/README.md"
"uri": "https://github.com/jfrog/jfrog-azure-devops-extension#readme"
},
"support": {
"uri": "https://www.jfrog.com/support"
Expand Down
Loading