Code Quality Pipeline Demo

​

Generating a GitHub Access Token

1. Click on your user icon in GitHub.
2. Go to Settings and then open Developer settings in a new tab.
3. Under the Personal Access Tokens section, select Token (classic) and click Generate new token.
4. Provide a name (e.g., “Jenkins”) and select the required scopes (for instance, the “repo” scope for full control over private repositories).
5. Generate the token and copy it.

​

Adding GitHub Credentials in Jenkins

1. Navigate to Credentials > System > Global credentials (unrestricted).
2. Add a new credential of type Username with password.
3. Use a placeholder username (e.g., “Jenkins”) and paste your access token as the password.
4. Assign an ID, such as “GitHub-access-token,” then save the credential.

​

Organizing Your Pipelines

1. Create a new folder by selecting New Item.
2. Name it “Final Project” and choose the Folder type.
3. Optionally assign a display name, then click Save.

1. Name it “pipeline code-quality”.
2. Select Multibranch Pipeline as the project type. This option provides features such as running the pipeline on multiple branches and triggering builds for pull requests.

​

Configuring Branch Sources in Jenkins

• Select GitHub.
• Choose the previously created credentials (GitHub-access-token). Even for public repositories, these credentials help avoid rate limits.
• Paste the repository URL and adjust branch discovery settings. Here, exclude branches filed as pull requests.
• For pull requests from the origin, select the option to merge the pull request with the target branch’s current revision. This ensures the pipeline tests the final merged code.
• Set the script path to “Jenkinsfile - code quality”.
• Choose a periodic scan interval (e.g., every two minutes for demonstration purposes) and save your configuration.

Started by user sanjeev
[Thu Sep 12 09:04:30 UTC 2024] Starting branch indexing...
09:04:30 Connecting to https://api.github.com using jenkins/******
Examining kodekloudhub/course-jenkins-project

Checking branches...
Getting remote branches...
Checking branch main

Getting remote pull requests...
'Jenkinsfile-Code-Quality' found
Met criteria
Scheduled build for branch: main

1 branches were processed
Checking pull-requests...
0 pull requests were processed

Finished examining kodekloudhub/course-jenkins-project
[Thu Sep 12 09:04:31 UTC 2024] Finished branch indexing. Indexing took 0.83 sec
Finished: SUCCESS

​

Understanding the Jenkinsfile for Code Quality Pipeline

• In the Pull Request Number stage, a conditional block prints the pull request number using the environment variable CHANGE_ID if the build is triggered by a pull request.
• The Environment Variables stage prints all Jenkins-provided environment details such as commit hash, branch name, and build URLs.

pipeline {
    agent any
    stages {
        stage('Environment Variables') {
            steps {
                sh 'printenv'
                sh 'ls -la'
            }
        }
        stage('Pull Request Number') {
            when {
                changeRequest target: 'main'
            }
            steps {
                echo "PR: ${CHANGE_ID}"
            }
        }
        stage('Setup') {
            steps {
                sh 'poetry install --with dev'
            }
        }
        stage('Test') {
            steps {
                sh 'poetry run pytest'
            }
        }
    }
}

git add Jenkinsfile
git commit -m "Add/update Jenkinsfile for code quality pipeline"
git push

The recommended git tool is: NONE
using credential github-access-token
/usr/bin/git rev-parse --resolve-git-dir /var/lib/jenkins/workspace/Final_Project_Code-Quality_main/.git # timeout=10
...
Commit message: "initial commit"
...
+ ls -la
total 152
drwxr-xr-x  7 jenkins jenkins 16384 Sep 12 09:08 .
...

​

Excluding the Main Branch from the Code Quality Pipeline

1. Modify the branch source configuration to include a name filter with wildcards.
2. Add an exclude filter for the main branch, then save the configuration.

​

Triggering the Code Quality Pipeline with Pull Requests

1. Ensure your local repository is up-to-date:
   git pull
   
2. Create a new feature branch:
   git checkout -b feature-one
   
3. Make changes (e.g., updating version identifiers or modifying code) and commit your changes.
4. Push the feature branch:
   git push origin feature-one
   

HOME=/var/lib/jenkins
LANG=C.UTF-8
JENKINS_URL=http://ec2-44-210-155-37.compute-1.amazonaws.com:8080/
JOB_BASE_NAME=feature1
JOB_NAME=Final_Project_Code-Quality/feature1
...
CHANGE_BRANCH=feature-one
...

- Installing tomlkit (0.13.2)
- Installing Werkzeug (0.3.3)
- Installing Flask (0.3.3)
- Installing pytest (8.3.2)
- Installing python-semantic-release (9.8.6)
...
+ poetry run pytest
============================= test session starts ==============================
platform linux -- Python 3.9.16, pytest-8.3.2, pluggy-1.5.0
rootdir: /var/lib/jenkins/workspace/Final_Project_Code-Quality_feature-one
collected 3 items
test_app.py ...      [100%]
============================== 3 passed in 0.26s ===============================

PWD=/var/lib/jenkins/workspace/Final_Project_Code-Quality_PR-31
...
CHANGE_BRANCH=feature-one
...
CHANGE_TARGET=main
...
CHANGE_ID=31
...

[Pipeline] stage (Pull Request Number)
[Pipeline] echo
PR: 31
[Pipeline] stage (Setup)
[Pipeline] sh
+ poetry install --with dev
...

​

Next Steps