Easy Github Docs

Appearance

Experiment 1 ​

Working with Maven: Creating a Maven Project, Understanding the POM File ​

Steps to Get Output : ​

  1. Create a New Maven Project:

    • Open IntelliJ IDEA.
    • Go to File > New > Project.
    • Select Maven from the project types.
    • Set the project name and location, then click Finish. 500

  2. Create a Simple Website (HTML, CSS, and Logo):

    • In the src/main/resources folder, create an index.html file, a style.css file, and place the image.png image.

Example of a simple index.html:

html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>My Simple Website</title>
    <link rel="stylesheet" href="style.css">
</head>
<body>
    <header>
        <img src="image.png" alt="Logo">
    </header>
    <h1>Welcome to My Simple Website</h1>
</body>
</html>

Example of style.css:

css
body {
    font-family: Arial, sans-serif;
    text-align: center;
    margin: 0;
    padding: 0;
    background-color: #f9f9f9;
}

header {
    background-color: #333;
    padding: 10px;
}

header img {
    height: 50px;
}

h1 {
    color: #333;
    margin-top: 20px;
}
  1. Upload the Website to GitHub:
    • Initialize a Git repository in your project folder:
bash
git init
  • Add your files and commit them:
bash
git add .
git commit -m "Initial commit"
  • Create a GitHub repository and push the local project to GitHub:
bash
git remote add origin <your-repository-url>
git push -u origin master

Experiment 2 ​

Installing and Setting Up Gradle in IntelliJ IDEA ​

Creating a Gradle Project in IntelliJ IDEA: ​

Step 1: Open IntelliJ IDEA and Create a New Project

  1. Click on "New Project".
  2. Select "Gradle" (under Java/Kotlin).
  3. Choose Groovy or Kotlin DSL (Domain Specific Language) for the build script.
  4. Set the Group ID (e.g., com.example).
  5. Click Finish. 500

Step 1: Modify build.gradle (Groovy DSL) (Copy paste the entire code, or you can just change if "id" to "application")

groovy
plugins {
    id 'application'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter:5.8.1'
}

application {
    mainClass = 'com.example.Main'
}

Step 2: See the Project Structure

my-gradle-project
├── build.gradle (Groovy Build Script)
├── settings.gradle
└── src
    ├── main
    │   ├── java
	|	|	└── com.example
	|	|		└── Main     <--- You need to edit this
    │   └── resources
    └── test
        ├── java
        └── resources

Step 3: edit Main.java in src/main/java/com/example

java
package com.example;

public class Main {
    public static void main(String[] args) {
        System.out.println("Hello from Gradle!");
    }
}

Step 3: Build and Run the Project

  • Press ALT + F12 to open terminal.
bash
gradle run

Hosting a Static Website on GitHub Pages ​

Step 1: Create a /docs Directory

  • Create docs inside the root folder (not in src).
  • Add your HTML, CSS, and images inside /docs.

Step 2: Modify build.gradle to Copy Website Files (This is optional)

groovy
task copyWebsite(type: Copy) {
    from 'src/main/resources/website'
    into 'docs'
}

Step 3: Commit and Push to GitHub

bash
git add .
git commit -m "Deploy website using Gradle"
git push origin main

Step 4: Enable GitHub Pages

  • Go to GitHub Repo -> Settings -> Pages.
  • Select the /docs folder as the source.

Your website will be hosted at:

https://yourusername.github.io/repository-name/

Experiment 3 ​

Working with Gradle: Setting Up a Gradle Project, Understanding Build Scripts ​

exact same as 2nd one copy same

Step 1: Open IntelliJ IDEA and Create a New Project

  1. Click on "New Project".
  2. Select "Gradle" (under Java/Kotlin).
  3. Choose Groovy or Kotlin DSL (Domain Specific Language) for the build script.
  4. Set the Group ID (e.g., com.example).
  5. Click Finish. 500

Step 1: Modify build.gradle (Groovy DSL) (Copy paste the entire code, or you can just change if "id" to "application")

groovy
plugins {
    id 'application'
}

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter:5.8.1'
}

application {
    mainClass = 'com.example.Main'
}

Step 2: See the Project Structure

my-gradle-project
├── build.gradle (Groovy Build Script)
├── settings.gradle
└── src
    ├── main
    │   ├── java
	|	|	└── com.example
	|	|		└── Main     <--- You need to edit this
    │   └── resources
    └── test
        ├── java
        └── resources

Step 3: edit Main.java in src/main/java/com/example

java
package com.example;

public class Main {
    public static void main(String[] args) {
        System.out.println("Hello from Gradle!");
    }
}

Step 4: Build and Run the Project

  • Press ALT + F12 to open terminal.
bash
gradle run

Hosting a Static Website on GitHub Pages ​

Step 1: Create a /docs Directory

  • Create docs inside the root folder (not in src).
  • Add your HTML, CSS, and images inside /docs.

Step 2: Modify build.gradle to Copy Website Files (This is optional)

groovy
task copyWebsite(type: Copy) {
    from 'src/main/resources/website'
    into 'docs'
}

Step 3: Commit and Push to GitHub

bash
git add .
git commit -m "Deploy website using Gradle"
git push origin main

Step 4: Enable GitHub Pages

  • Go to GitHub Repo -> Settings -> Pages.
  • Select the /docs folder as the source.

Your website will be hosted at:

https://yourusername.github.io/repository-name/

Experiment 4 ​

Gradle Kotlin DSL: Setting Up & Building a Kotlin Project in IntelliJ IDEA ​

Finally fixed this Nonsense

Setting Up the Gradle Project ​

Step 1: Create a New Project

  1. Open IntelliJ IDEA.
  2. Click on File > New > Project.
  3. Give a Project name

500

Note down the java JDK version carefully in this step !!! Also Note Down the GroupID in my case com.example is the default, yours might be org.example also i'll be using jdk version 21 so be careful.

Observe in the project structure, that there is no org.example or com.example.... you need to create a org.example or com.example folder under kotlin folder.

400

400

next drag and drop the Main.kt file inside the org.example folder.

Editing the Main Kotlin File ​

Copy paste this Main.kt file. Be careful about org.example or com.example.

kotlin
package com.example

fun main() {
    println("Hello, Gradle with Kotlin DSL!")
}
Understanding build.gradle.kts ​

Copy paste this code to build.gradle.kts and make the necessary changes:

kotlin
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile  
  
plugins {  
    kotlin("jvm") version "2.1.10"  // this version can be a problem sometimes  
    application  
}  // alternatively try with "1.8.10"  
  
group = "com.example"  //change to org.example if thats your default groupID  
version = "1.0-SNAPSHOT"  
  
repositories {  
    mavenCentral()  
}  
  
dependencies {  
    implementation(kotlin("stdlib"))  
    testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.2")  
    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.2")  
}  
  
tasks.test {  
    useJUnitPlatform()  
}  
  
tasks.withType<KotlinCompile> {  
    kotlinOptions.jvmTarget = "21" // Match with your JDK version !!!  
}  
  
kotlin {  
    jvmToolchain(21)  // Here too !!  
}  
  
application {  
    mainClass.set("com.example.MainKt") // Use your package + filename here  
}
Building and Running the Project ​

Build the Project

bash
./gradlew build

Run the Project

bash
./gradlew run

Packaging as a JAR ​

To run the project without Intellij, we need a JAR file.

  1. Create a Fat (Uber) JAR Modify build.gradle.kts:
kotlin
tasks.register<Jar>("fatJar") {
    archiveClassifier.set("all")
    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
    manifest {
        attributes["Main-Class"] = "com.example.MainKt" //change to org.example if your groupId is org.example
    }
    from(configurations.runtimeClasspath.get().map { if (it.isDirectory) it else zipTree(it) })
    with(tasks.jar.get() as CopySpec)
}
  1. Build the Fat JAR
bash
./gradlew fatJar

This command will create a jar file inside build/libs. locate the file 500

  1. Run the Fat JAR
bash
java -jar build/libs/Experiment4New-1.0-SNAPSHOT-all.jar

Note your filename may be different so replace with build/libs/FILENAME-all.jar, replaceing FILENAME with your project filename.

Experiment 5 ​

Build and Run a Java Application with Maven, Migrate the Same Application to Gradle ​

Create and Build a Java Application with Maven ​

  1. Create a Maven Project in IntelliJ IDEA

    1. Open IntelliJ IDEA
      • Launch IntelliJ IDEA and click on File -> New -> Project.
    2. Select Maven
      • In the New Project window, choose Maven from the options on the left.
      • Check Create from archetype and select maven-archetype-quickstart.
      • Click Next. 500
    3. Wait for IntelliJ to Load Dependencies
      • IntelliJ will automatically download the Maven dependencies, so just relax for a moment.

  2. Update pom.xml to Add Build Plugin. Copy paste this entire shit.

xml
<project xmlns="http://maven.apache.org/POM/4.0.0" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
                             http://maven.apache.org/xsd/maven-4.0.0.xsd">
  
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.example</groupId>
  <artifactId>Experiment5</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>jar</packaging>

  <name>Experiment5</name>
  <url>http://maven.apache.org</url>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  </properties>

  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <!-- Compiler Plugin -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.8.1</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
        </configuration>
      </plugin>

      <!-- Jar Plugin -->
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>3.2.0</version>
        <configuration>
          <archive>
            <manifest>
              <mainClass>com.example.App</mainClass>
            </manifest>
          </archive>
        </configuration>
      </plugin>
    </plugins>
  </build>

</project>
  1. Build and Run the Maven Project Press Alt + F12 to open the terminal.
bash
mvn clean compile
mvn package
  1. After the above command a Jar file will be create find it inside the project directory structure :
D:\Idea Projects\MVNGRDLDEMO\target\Experiment5-1.0-SNAPSHOT.jar <---- This might be different in your system

400

  1. Run the JAR File To run the generated JAR file, use:
bash
java -jar target\Experiment5-1.0-SNAPSHOT.jar
Migrate Maven Project to Gradle ​

Step 1: Initialize Gradle in Your Project

  1. Open terminal (if not open) using ALT + F12 and check if your in the project directory only :
bash
cd "D:\Idea Projects\Experiment5"
  1. Run Gradle Init Command Execute the following command to migrate your Maven project to Gradle:
bash
gradle init --type pom

This command will convert your Maven pom.xml into a Gradle build.gradle file.

select Groovy in this step and second question just hit enter.

Step 2: Add these lines to the end of existing build.gradle

groovy
group = 'com.example'
version = '1.0-SNAPSHOT'

jar {
    manifest {
        attributes(
            'Main-Class': 'com.example.App'
        )
    }
}

Step 3: Open terminal using ALT+F12 and run the build command

bash
gradle clean build

Step 4: After the above command a Jar file will be create find it inside the project directory structure :

D:\Idea Projects\MVNGRDLDEMO\target\Experiment5-1.0-SNAPSHOT.jar <---- This might be different in your system

500 Step 5: Run the JAR File To run the generated JAR file, use:

bash
java -jar build\libs\Experiment5-1.0-SNAPSHOT.jar

Experiment 6 ​

Jenkins Installation Guide ​

System Requirements ​
  • Memory: 256 MB of RAM
  • Disk Space: Depends on your projects
  • Operating System: Windows, Mac, Ubuntu, Linux
  • Java Version: Java 8 or 11 (JDK or JRE)
Installation on Windows - Step-by-Step Instructions ​
  1. Check if Java is installed
  2. Download the jenkins.war file from the official site
  3. Open Command Prompt and run the following command:
bash
 java -jar jenkins.war --httpPort=8080
  1. Open your browser and go to: http://localhost:8080
  2. Provide the admin password and complete the setup wizard

Jenkins Configuration - How to Change Jenkins Home Directory ​

  1. Navigate to: Manage Jenkins ➝ Configure System to view your current JENKINS_HOME
  2. Create a new folder where you want Jenkins to store its data
  3. Copy the contents of the old JENKINS_HOME to the new folder
  4. Set or update the environment variable JENKINS_HOME to the new path
  5. Restart Jenkins

Configuration File Reference:

  • jenkins.xml
  • Environment Variable: JENKINS_HOME

Setting Up Git on Jenkins ​

Step-by-Step Git Plugin Setup ​
  1. Go to Manage Jenkins ➝ Manage Plugins
  2. Check the Installed tab to see if Git is already installed
  3. If not, go to the Available tab and search for Git
  4. Click Install to install the Git plugin
  5. After installation, verify that the Git option appears in the Job Configuration section

Creating Your First Job in Jenkins ​

Connecting Jenkins to a Git Remote Repository (e.g., GitHub) ​
  1. Get the URL of the remote Git repository (HTTPS or SSH)
  2. Add Git credentials to Jenkins:
    • Go to Manage Jenkins ➝ Credentials
    • Add the username/password or SSH key under the appropriate scope
  3. In your job's configuration:
    • Go to the Source Code Management (SCM) section
    • Select Git
    • Enter the Git repository URL
  4. Add the credentials you created earlier
  5. Run the job and verify if the repository is successfully cloned

Jenkins Command Line Interface (CLI) ​

Why Use CLI? ​

Faster, easier, seamless integration with Jenkins.

How to Use Jenkins CLI ​

  1. Start Jenkins
  2. Go to: Manage Jenkins ➝ Configure Global Security ➝ Enable Security
  3. Open your browser and visit:
    http://localhost:8080/cli/
  4. Download the jenkins-cli.jar and place it anywhere on your system
  5. Test Jenkins CLI with the following command:
    bash
    java -jar jenkins-cli.jar -s http://localhost:8080/ help --username <userName> --password <password>

User and Role Management in Jenkins - Creating Users and Assigning Roles ​

  1. Create new users from Manage Jenkins ➝ Manage Users
  2. Configure users as needed
  3. Install the Role-Based Authorization Strategy Plugin
    • Go to Manage Jenkins ➝ Manage Plugins ➝ Available ➝ Search & Install
    • Restart Jenkins after installation
  4. Go to: Manage Jenkins ➝ Configure Global Security ➝ Authorization ➝ Select Role-Based Strategy
  5. Go to: Manage Jenkins ➝ Manage and Assign Roles
    • Create Roles
    • Assign Roles to Users
  6. Validate that authentication and authorization work as expected

Jenkinsfile – Pipeline as Code ​

Build ➝ Deploy ➝ Test ➝ Release ​

How to Create a Jenkinsfile ​

  1. Start Jenkins
  2. Install the Pipeline Plugin from Manage Plugins
  3. Create a new job
  4. In the job configuration, go to the Pipeline section:
    • Select Pipeline Script
    • Write or paste your Jenkinsfile here
  5. Run the job and verify the output

Jenkins Pipeline from Git SCM ​

Use Jenkinsfile from a Git Repository ​
  1. Create a new job or use an existing job (Job Type: Pipeline)
  2. Create a Git repository (e.g., on GitHub)
  3. Add a Jenkinsfile to the repository
  4. In the job configuration:
    • Go to Pipeline ➝ Definition: Pipeline script from SCM
    • SCM: Git
    • Provide the repository URL
    • Specify the Jenkinsfile location in the repo
  5. Save the job
  6. Run the job and validate the pipeline execution