How to Integrate Slack with GitHub Actions | Slack Integration with GitHub Actions| Send Push notifications to Slack GitHub Actions

Integrating Slack with GitHub Actions for sending Notifications

Pre-requisites:

• Slack workspace is configured and channel created
• Make sure your Project is setup in GitHub

How to integrate Slack with GitHub Actions

We will be using slack GitHub Action Slack integration action for posting messages to Slack channel from GitHub Actions.

We will be following below steps:

1. Create a new App in https://api.slack.com/apps

2. Select workspace in the app

3.Select incoming webhooks

4. Activate incoming webhook

5. Add new webhook integration

6. Select channel, Allow

7. Copy the webhook url

Create App from scratch

Enter App name and pick a workspace

Click on incoming webhooks

Activate incoming webhooks, click on Add new webhook to workspace

Select the channel where you want to send notfications

Copy webhook url

Add Slack Webhook URL as Secret in GitHub Actions

Go to your GitHub Repo --> Settings --> 

Click on Secrets and Variables under Security in left nav 

Click new Repository Secret

Add SLACK_WEBHOOK_URL with value

Create GitHub Actions CICD workflow yaml:

Go to GitHub repo where your Java project is, create a new file:

.github/workflows/cicd.yml

name: cicd-workflow with slack integration

on:

  push:

    branches: [ "master" ]

jobs:

  job1:

    runs-on: ubuntu-latest

    env:

      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}

    steps:

    - uses: act10ns/slack@v2

      with:

        status: starting

        channel: '#mar-2024-weekend-batch'

        message: Starting Docker Build image...

      if: always()

    - uses: actions/checkout@v3

    - name: Build Docker image

      run: |

        docker build -t my-docker-repo .

    - uses: act10ns/slack@v2

      with:

        channel: '#mar-2024-weekday-batch'

        status: ${{ job.status }}

        steps: ${{ toJson(steps) }}

      if: always()

Watch Steps in YouTube channel:

How to integrate SonarQube with GitHub Actions | SonarQube Integration with GitHub Actions| Automate Code Scan using SonarQube In GitHub Actions

 Please find steps for integrating SonarQube with GitHub Actions

Pre-requisites:

• Make sure SonarQube is up and running
• Make sure Java Project is setup in GitHub

How to integrate SonarQube with GitHub Actions:

We will be following below steps:

• Create Token in SonarQube to authenticate with GitHub Actions
• Add Sonar Token, SonarQube URL as Secrets in GitHub Actions
• Create GitHub Actions CICD workflow yaml
• Add tasks for Maven build and Sonar Scan
• Run the workflow in GitHub hosted runner(Ubuntu)
• Verify scan report in SonarQube

Create Token in SonarQube to authenticate with GitHub Actions

You need to login to SonarQube using your admin password and click on Admin on your top side.

Click on My Account, Security. 

Under Tokens, Give some value for token name and choose global analysis token, click on generate Tokens. Copy the token value generated.

Add Sonar Token and Sonar Host URLs as Secret in GitHub Actions

Go to your GitHub Repo --> Settings --> 

Click on Secrets and Variables under Security in left nav 

Click new Repository Secret

Add another variable for storing Sonar token

Create GitHub Actions CICD workflow yaml:

Go to GitHub repo where your Java project is, create a new file:

.github/workflows/cicd.yml

The below file have four steps(tasks) 

    - Checkout

    - Install Java on runner

    - Build using Maven

    - run Sonar Scan (this task need to have projectKey defined, otherwise build will fail)

Copy the content from below:

name: CI/CD workflow for Maven Build and Sonar Code scan
on:
  push:
    branches:
      - main
  workflow_dispatch:
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout code
      uses: actions/checkout@v2
    - name: Set up JDK 11
      uses: actions/setup-java@v2
      with:
        distribution: 'adopt'
        java-version: '11'
    - name: Build with Maven
      run: mvn clean install -f MyWebApp/pom.xml
    - name: SonarQube Scan
      uses: sonarsource/sonarqube-scan-action@v1
      with:
        projectBaseDir: .
        args: >
          -Dsonar.organization=my-org
          -Dsonar.projectKey=my-Java-web-app
      env:
        SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
        SONAR_HOST_URL: ${{ secrets.SONAR_HOST_URL }}

Commit the file.

As soon as you commit, build will run immediately in GitHub Actions. 

Now you can see the output of build in Actions tab.

Now login to SonarQube to see the Scan report

Notes:

You can also refer the documentation below from below websites.

https://docs.sonarsource.com/sonarqube/latest/devops-platform-integration/github-integration/

https://github.com/marketplace/actions/official-sonarqube-scan

Watch steps in YouTube channel: 

How to configure Self-Hosted GitHub Actions Runner | How to install Self-Hosted GitHub Actions Runner | Configure EC2 instance as self-hosted runner in GitHub Actions

A self-hosted GitHub runner is a machine (physical or virtual) that you set up and manage to run GitHub Actions workflows. A self-hosted runner differs from the default GitHub-hosted runners in that it runs on infrastructure that you control. Self-hosted runners can be physical, virtual, in a container, on-premises, or in a cloud. To learn more about GitHub runner, please click here.

Advantages of self-hosted runners:

• full control over the environment and tools
• Any size machine or configuration
• Secure access and networking

Pre-requisites:

• Project configured in GitHub
• workflow yaml already checked-in GitHub. If you don't have one, click here to create one.
• Create a virtual machine with at least 2 GB RAM. we will use EC2 instance in AWS cloud.
• Install Maven on runner EC2 instance

How to create self-hosted GitHub Actions Runner?

Go to GitHub Repo--> Actions --> Runners

Click on self-hosted runners --> New Runner

Click on Linux

Perform update

sudo apt update

Install Maven in Runner EC2 as We will be doing Maven build for Java project

sudo apt install maven -y

Execute below commands in your virtual machine to configure runner.

Download installables

# Create a folder

mkdir actions-runner && cd actions-runner

# Download the latest runner package

 curl -o actions-runner-linux-x64-2.313.0.tar.gz -L https://github.com/actions/runner/releases/download/v2.313.0/actions-runner-linux-x64-2.313.0.tar.gz

# Extract the installer

tar xzf ./actions-runner-linux-x64-2.313.0.tar.gz

Configure the runner

./config.sh --url https://github.com/akannan1087/myJan2024WeekdayRepo --token Token

Enter the name of the runner group to add this runner to: [press Enter for Default]

press enter default for the runner group

Enter name of the runner 

MyRunner1

Enter any additional labels

MyRunner1

Now run the runner

./run.sh

this confirms that runner is setup and running fine. waiting for the jobs.

you can also view in GitHub under Runners tab:

Create a workflow or modify your workflow to include GitHub runner:

name: Build a WAR file using Maven

on:

  push:

    branches: [ "main" ]

jobs:

  build:

    runs-on: self-hosted

    steps:

    - uses: actions/checkout@v3

    - name: Set up JDK 11
      uses: actions/setup-java@v2
      with:
        distribution: 'adopt'
        java-version: '11'
    - name: Build with Maven
      run: mvn clean install -f MyWebApp/pom.xml

Save the file and run the workflow.

Go to your virtual machine where build is running:

Watch steps in YouTube channel:

stderr: remote: Support for password authentication was removed on August 13, 2021. Please use a personal access token instead | Fix for this issue

 

Support for password authentication was removed on August 13, 2021

How to Fix for the above error:GitHub removed password authentication support from August 13, 2021 instead it recommends to use either OAuth or Personal Access Token.

Create Personal Access Token in GitHub

Go to GitHub.com--> Settings

Go to Developer Settings 

Go to Personal Access tokens --> Generate new token

Enter name for the token, choose no expiration if you don't want your token to expire.

Select repo and click generate token

Now copy the token and use this as password.

How to Integrate Jenkins and GitHub using SSH keys? | Jenkins and GitHub Integration

We will see how to connect to GitHub from Jenkins using SSH keys instead of using user name and password. It is also a good practice to use SSH keys in Jenkins jobs instead of using user name and password.

Watch the steps in YouTube channel:

Pre-requistes:

• Jenkins is up and running
• Credentials plug-in installed in Jenkins

Create SSH keys in your Jenkins EC2 instance

ssh-keygen

enter four times. this will create keys in .ssh folder.

Copy and paste the public key

sudo cat ~/.ssh/id_rsa.pub

Add public Keys into your respective GitHub

Add public keys into your Repository--> settings--> Deploy keys section

Click on Add Deploy Key and enter public keys and save.

Add Private Keys in Jenkins Master

Login Jenkins. Go to Manage Jenkins. click on Credentials

Click on Jenkins

Click on Global Credentials

Click on Add Credentials

Choose SSH username with private key

Choose SSH username with private key
username can be anything
Click on enter directly under private key option and Click Add

Copy and paste private key(not public key) of your from Jenkins instance. command is below:
sudo cat ~/.ssh/id_rsa

copy the content of whole output from above command.

Click OK to save.

Now go to any Jenkins Job, you can choose this option for checking out from GitHub. Make sure you enter SSH url not https url.

That's it. This is how you use SSH url and private keys to checkout code from bitbucket or Github without entering username/password in Jenkins.