Skip to content

Commit

Permalink
Merge pull request #13 from sonatype-nexus-community/lifecyle-branding
Browse files Browse the repository at this point in the history 
rebrand Nexus to Sonatype Lifecycle
  • Loading branch information
@adamjwsuch
adamjwsuch authored Jun 19, 2024
2 parents 21671e5 + 195637d commit bd8b23b
Showing 1 changed file with 35 additions and 40 deletions.
75 changes: 35 additions & 40 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,36 +1,35 @@
# nexus-ci-examples
CI example builds for different languages
Each of the examples are split into separate Git branches, so they can easily automatically be pulled into a Jenkins multibranch build job.

|Language|Build System|Scanner|Branch|
|----|----|----|:----|
|C++|cmake|Nexus IQ CLI|[c++-cmake-opencv](../../tree/c++-cmake-opencv)|
|Java|Gradle/Android Studio|Nexus IQ CLI|[java-android-gradle-LeafPic](../../tree/java-android-gradle-LeafPic)|
|Java|Gradle/Android Studio|Nexus IQ CLI|[java-android-gradle-nextcloud](../../tree/java-android-gradle-nextcloud)|
|Java|Maven|Nexus IQ Jenkins Plugin|[java-maven-struts2-rce](../../tree/java-maven-struts2-rce)|
|Java|Maven|Nexus IQ Jenkins Plugin|[java-maven-webgoat](../../tree/java-maven-webgoat)|
|Javascript|NPM|AuditJS|[javascript-auditjs-juiceshop](../../tree/javascript-auditjs-juiceshop)|
|Javascript|NPM|Nexus IQ Jenkins Plugin|[javascript-npm-juiceshop](../../tree/javascript-npm-juiceshop)|
|Javascript|NPM|Nexus IQ Jenkins Plugin|[javascript-npm-nodegoat](../../tree/javascript-npm-nodegoat)|
|PHP|Composer|Nexus IQ CLI|[php-composer-symfony](../../tree/php-composer-symfony)|
|Python|PIP|Jake|[python-jake-homeassistant](../../tree/python-jake-homeassistant)|
|Python|PIP|Nexus IQ Jenkins Plugin|[python-pip-homeassistant](../../tree/python-pip-homeassistant)|
|Rust|Rust|Nexus IQ Jenkins Plugin|[rust-rust-story](../../tree/rust-rust-story)|

To make the builds repeatable and simple, this project include Jenkins Docker build nodes provided as Docker containers with a preconfigured build environment for each ecosystem; for example for Maven build example, the container preconfigures Maven and Java. The Dockerfile and supporting content are provided with each build example branch.

# Usage instructions for Jenkins
Jenkins setup

You will need the "Docker" and “Nexus Platform” plugins
# Sonatype Lifecycle CI Examples
CI example builds and Sonatype Lifecycle analysis for different languages.

Jenkins -> Manage Jenkins -> Manage Plugins -> Available
Each of the examples are split into separate Git branches, so they can easily automatically be pulled into a CI multibranch build job, as explained below for Jenkins CI.

Type: “Nexus Platform” in the search box
|Language |Build System |Lifecycle Integration |Git Branch|
|----------|---------------------|----------------------------------|:-----|
|C++ |cmake |[Sonatype CLI][CLI] |[c++-cmake-opencv](../../tree/c++-cmake-opencv)|
|Java |Gradle/Android Studio|[Sonatype CLI][CLI] |[java-android-gradle-LeafPic](../../tree/java-android-gradle-LeafPic)|
|Java |Gradle/Android Studio|[Sonatype CLI][CLI] |[java-android-gradle-nextcloud](../../tree/java-android-gradle-nextcloud)|
|Java |Maven |[Sonatype Jenkins Plugin][Jenkins]|[java-maven-struts2-rce](../../tree/java-maven-struts2-rce)|
|Java |Maven |[Sonatype Jenkins Plugin][Jenkins]|[java-maven-webgoat](../../tree/java-maven-webgoat)|
|Javascript|NPM |AuditJS |[javascript-auditjs-juiceshop](../../tree/javascript-auditjs-juiceshop)|
|Javascript|NPM |[Sonatype Jenkins Plugin][Jenkins]|[javascript-npm-juiceshop](../../tree/javascript-npm-juiceshop)|
|Javascript|NPM |[Sonatype Jenkins Plugin][Jenkins]|[javascript-npm-nodegoat](../../tree/javascript-npm-nodegoat)|
|PHP |Composer |[Sonatype CLI][CLI] |[php-composer-symfony](../../tree/php-composer-symfony)|
|Python |PIP |Jake |[python-jake-homeassistant](../../tree/python-jake-homeassistant)|
|Python |PIP |[Sonatype Jenkins Plugin][Jenkins]|[python-pip-homeassistant](../../tree/python-pip-homeassistant)|
|Rust |Rust |[Sonatype Jenkins Plugin][Jenkins]|[rust-rust-story](../../tree/rust-rust-story)|

To make the builds repeatable and simple, this project include Jenkins Docker build nodes provided as Docker containers with a preconfigured build environment for each ecosystem; for example for Maven build example, the container [preconfigures Maven and Java](https://github.com/sonatype-nexus-community/nexus-ci-examples/blob/java-maven-struts2-rce/jenkins-node-maven/Dockerfile). The Dockerfile and supporting content are provided with each build example branch.

## Usage instructions for Jenkins
### Jenkins setup

You will need the Jenkins "Docker" and “Nexus Platform” plugins

Jenkins -> Manage Jenkins -> Manage Plugins -> Available
Type: “Nexus Platform” in the search box
Select the Nexus Platform plugin, then “Install without restart”

Configure the Nexus Plugin
### Configure the Nexus Plugin
Jenkins -> Manage Jenkins -> Configure System

Scroll down to the Sonatype Nexus section
Expand All @@ -39,28 +38,21 @@ Scroll down to the Sonatype Nexus section

and add the IQ server configuration and cridentials, you can check the connection on this page.

Install the Docker Plugin
### Install the Docker Plugin
Jenkins -> Manage Jenkins -> Manage Plugins -> Available

Type: “Docker” in the search box

Select the “Docker” plugin (not the Docker API plugin)

Select “Download now and install after restart”

Select the “Restart after download when no jobs are running”

Configure the Docker Cloud
### Configure the Docker Cloud
The groovy scipt on the project can automate the setup of the Docker plugin.

Click on the set-up-cloud.groovy file

Click the “raw” button near the top

Copy the entire file

Login to Jenkins:

Jenkins -> Manage Jenkins -> Script Console (it’s under Tools and Actions)

Paste the text/copy buffer into the window
Expand All @@ -70,10 +62,10 @@ For example if you use Docker Desktop and your IQ server is running on the same
You will also need to configure the location the system can use to reach your docker host. For a local Jenkins and Docker install the unix socket in the default config will work, for other systems, such as Jenkins within docker you will need to mount the socket as a volume or expose the API to http.


Jenkins Job Configuration
### Jenkins Job Configuration
Before configuring this, you need to create a GitHub token for Jenkins to access the GitHub repository with. Failure to do this will result in errors caused by hitting the GitHub API limits.

Create a GitHub “Token”
### Create a GitHub “Token”
Open http://www.github.com and “Signin”. You may need to provide your 2FA token using Google Authenticator.

Click on your user icon in the upper right corner -> Settings
Expand All @@ -83,7 +75,7 @@ At the bottom left -> Developer settings -> Personal access tokens
[Generate new token]


Create the Jenkins job
### Create the Jenkins job

Jenkins -> Create a job

Expand Down Expand Up @@ -120,3 +112,6 @@ Jenkins -> Create a job


At this point – Builds for all the platforms/eco-systems will automatically kick off.

[CLI]: https://help.sonatype.com/en/sonatype-iq-cli.html
[Jenkins]: https://help.sonatype.com/en/sonatype-platform-plugin-for-jenkins.html

0 comments on commit bd8b23b

Please sign in to comment.