Merge pull request #67 from abnamro/1968266-ChartReleaserAction

[#1968266] Added new action in the workflows that allows Helm Charts to be released

Author: DamienVermaas

.github/workflows/k8-infra-ci.yaml

@@ -10,7 +10,7 @@ on:
     branches: [ "main" ]
     paths:
       - .github/workflows/k8-infra-ci.yaml
-      - components/kubernetes/**
+      - deployment/kubernetes/**
 
 env:
   KUBERNETES_INFRA_DIR: deployment/kubernetes
@@ -23,6 +23,8 @@ jobs:
     steps:
     - name: Checkout Repository
       uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
 
     - name: Set up Helm
       uses: azure/setup-helm@v3
@@ -64,4 +66,29 @@ jobs:
         quiet: true
         soft_fail: true
         output_format: json
-    
+
+  release-charts:
+    name: Release Charts
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    needs: helm-chart-validation
+    if: github.ref == 'refs/heads/main'
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Configure Git
+      run: |
+        git config user.name "$GITHUB_ACTOR"
+        git config user.email "$GITHUB_ACTOR@users.noreply.github.com"
+
+    - name: Run chart-releaser
+      uses: helm/chart-releaser-action@v1.5.0
+      with:
+        charts_dir: deployment
+      env:
+        CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

deployment/kubernetes/Chart.yaml

@@ -4,9 +4,9 @@ description: A Helm chart for the Repository Scanner
 
 type: application
 
-version: 1.0.0
+version: 1.0.1
 
-appVersion: "1.0.0"
+appVersion: "1.0.1"
 
 dependencies:
     - name: resc-vcs-instances

deployment/kubernetes/README.md

@@ -8,6 +8,7 @@
     - [Prerequisites](#prerequisites)
     - [Testing templates](#testing-templates)
     - [Deploying charts](#deploying-charts)
+    - [Github as Helm Chart Repository](#github-as-helm-chart-repository)
 4. [Additional Information](#additional-information)
     - [Trigger scanning](#trigger-scanning)
     - [Connect to database using Azure Data Studio](#connect-to-database-using-azure-data-studio)
@@ -49,7 +50,7 @@ curl https://raw.githubusercontent.com/zricethezav/gitleaks/master/config/gitlea
 Create two folders in your user folder and name them _database_ and _rabbitmq_ as described below.
 
 Windows: C:\Users\<username>\resc\database and C:\Users\<username>\resc\rabbitmq  
-Linux: /Users/<username>/var/resc/database and /Users/<username>/var/resc/rabbitmq  
+Linux: /Users/<username>/var/resc/database and /Users/<username>/var/resc/rabbitmq
 
 Update persistent volume claim path and hostOS for database.
 ```
@@ -92,8 +93,8 @@ Below is an example for how to scan repositories from GitHub.
   For example, let's say you want to scan all the repositories for the following GitHub accounts.  
   https://github.com/kubernetes  
   https://github.com/docker
-  
-  Then you need to add those accounts to scope like : ["kubernetes", "docker"]. All the repositories from those accounts will be scanned. 
+
+  Then you need to add those accounts to scope like : ["kubernetes", "docker"]. All the repositories from those accounts will be scanned.
 * exceptions (optional): If you want to exclude any account from scan, then add it to exceptions. Default is empty exception.
 * usernameValue: Provide your GitHub username.
 * tokenValue: Provide your GitHub personal access token if you wish to scan private repositories.
@@ -134,10 +135,10 @@ Render chart templates locally and display the output.
 helm template resc . -f ./example-values.yaml --set-file global.secretScanRulePackConfig=./RESC-RULE.toml
 ```
 
-## Deploying charts 
+## Deploying charts
 Make sure you have completed the [pre-requisite](#prerequisites) steps.
 
-* Ensure the namespace is created, if not then run 
+* Ensure the namespace is created, if not then run
   ```bash
   kubectl create namespace resc
   ```
@@ -146,11 +147,11 @@ Make sure you have completed the [pre-requisite](#prerequisites) steps.
   cd ./deployment/kubernetes/
   ```
 
-* Deploy the helm charts.  
+* Deploy the helm charts.
   ```bash
   helm install --namespace resc resc . -f ./example-values.yaml --set-file global.secretScanRulePackConfig=./RESC-RULE.toml
   ```
-  
+
 * Optionally, set the default namespace for all kubectl commands. Now you no longer need to specify the -n resc option for all the kubectl commands.
   ```bash
   kubectl config set-context --current --namespace=resc
@@ -172,6 +173,12 @@ Make sure you have completed the [pre-requisite](#prerequisites) steps.
   helm uninstall resc --namespace resc
   ```
 
+### GitHub as Helm Chart Repository
+It is now possible to directly download the files from the Repository Scanner (RESC) GitHub Repository since it now also
+acts as a helm repository! This helm repository allows for a quicker and easier way to obtain the helm charts and use them
+on your machine. For a full step-by-step approach on how to install the helm charts, visit the README on the "gh-pages" branch
+linked [here](https://github.com/abnamro/repository-scanner/blob/gh-pages/README.md).
+
 ## Additional Information
 ### Issue while pulling images?
 If any image is not getting pulled automatically from the registry, you can use `docker pull` command to pull that image manually.