Skip to content

Commit

Permalink
Add an explanation about build-info in the README (#71)
Browse files Browse the repository at this point in the history
  • Loading branch information
yahavi authored May 23, 2023
1 parent d95b83f commit a85d278
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [Using JFrog CLI in your pipeline jobs](#using-jfrog-cli-in-your-pipeline-jobs)
- [Setting the build name and build number](#setting-the-build-name-and-the-build-number)
- [Using multiple JFrog Platform instances](#using-multiple-jfrog-platform-instances)
- [Publishing and accessing the build-info](#publishing-and-accessing-the-build-info)
- [Jenkins Configuration as Code](#jenkins-configuration-as-code)
- [Examples](#examples)
- [Contributions](#contributions)
Expand Down Expand Up @@ -156,6 +157,21 @@ jf 'rt u test-file my-repo –-server-id server-1'
jf 'rt u test-file my-repo –-server-id server-2'
```

### Publishing and accessing the build-info
[Build-info](https://www.buildinfo.org/) is the metadata of a build. It includes all the details about the build broken down into segments that include version history, artifacts, project modules, dependencies, and everything that was required to create the build. In short, it is a snapshot of the components used to build your application, collected by the build agent.
See below how you publish the build-info from your pipeline jobs. This section should be placed inside the job after the execution of the JFrog CLI commands used for the build.
```groovy
stage('Publish build info') {
steps {
jf 'rt build-publish'
}
}
```
When the job publishes the build-info to Artifactory, you can access it by clicking on the build-info icon, next to the job run.

![build-info.png](images/readme/build-info.png)


## Jenkins Configuration as Code

To configure this plugin on Jenkins Configuration as Code, add the following sections to the jenkins.yaml:
Expand Down
Binary file added images/readme/build-info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a85d278

Please sign in to comment.