update zammad docker image to 3.5.0-11, updated ci & repo infos (zamm…

…ad#66)

* update zammad docker image to 3.5.0-11, updated ci & repo infos

* added super linter as dependency

* changed README to reflect new repo links

.github/linters/.markdown-lint.yml

@@ -0,0 +1,2 @@
+MD013:
+  line_length: 400

.github/workflows/ci.yaml

@@ -2,23 +2,29 @@ name: ci
 
 on:
   pull_request:
+    branches:
+      - master
     paths:
       - 'zammad/**'
 
 jobs:
-  lint-bash-scripts:
+  super-linter:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - name: Checkout Code
         uses: actions/checkout@v2
-      - name: Lint Bash scripts
-        uses: docker://koalaman/shellcheck-alpine:v0.7.1
-        with:
-          args: .github/lint-scripts.sh
+
+      - name: Lint Code Base
+        uses: github/super-linter@v3
+        env:
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_KUBERNETES_KUBEVAL: false
+          VALIDATE_YAML: false
 
   lint-chart:
     runs-on: ubuntu-latest
-    needs: lint-bash-scripts
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -32,22 +38,23 @@ jobs:
 
   kubeval-chart:
     runs-on: ubuntu-latest
-    needs: lint-chart
+    needs:
+      - lint-chart
+      - super-linter
     strategy:
       matrix:
         k8s:
-          - v1.15.7
           - v1.16.4
           - v1.17.4
           - v1.18.1
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Fetch history
-        run: git fetch --prune --unshallow         
+        run: git fetch --prune --unshallow
       - name: Run kubeval
         env:
-          KUBERNETES_VERSION: ${{ matrix.k8s }}         
+          KUBERNETES_VERSION: ${{ matrix.k8s }}
         run: .github/kubeval.sh 
 
   install-chart:
@@ -59,16 +66,15 @@ jobs:
     strategy:
       matrix:
         k8s:
-          - v1.15.12
           - v1.16.15
           - v1.17.11
-          - v1.18.6
+          - v1.18.8
           - v1.19.1
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Fetch history
-        run: git fetch --prune --unshallow         
+        run: git fetch --prune --unshallow
       - name: Create kind ${{ matrix.k8s }} cluster
         uses: helm/kind-action@master
         with:

.github/workflows/deploy.yaml

@@ -2,7 +2,8 @@ name: deploy
 
 on:
   push:
-    branches: [master]
+    branches: 
+      - master
 
 jobs:
   deploy-chart:
@@ -14,7 +15,7 @@ jobs:
       - name: Lint Bash scripts
         uses: docker://koalaman/shellcheck-alpine:v0.7.0
         with:
-          args: .github/lint-scripts.sh        
+          args: .github/lint-scripts.sh
       - name: Set user permissions
         run: chmod -R 777 /home/runner/work
       - name: Deploy Helm chart

.github/workflows/release.yaml

@@ -0,0 +1,33 @@
+name: Release Charts
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Fetch history
+        run: git fetch --prune --unshallow
+
+      - name: Configure Git
+        run: |
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+
+      # See https://github.com/helm/chart-releaser-action/issues/6
+      - name: Install Helm
+        run: |
+          curl -fsSLo get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
+          chmod 700 get_helm.sh
+          ./get_helm.sh
+
+      - name: Run chart-releaser
+        uses: helm/[email protected]
+        env:
+          CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/sync-readme.yaml

@@ -0,0 +1,29 @@
+name: sync-readme
+
+on:
+  push:
+    branches:
+      - 'master'
+    paths:
+      - 'README.md'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - run: |
+          cp -f README.md ${{ runner.temp }}/README.md
+
+      - uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+
+      - run: |
+          cp -f ${{ runner.temp }}/README.md .
+          git config user.name "$GITHUB_ACTOR"
+          git config user.email "[email protected]"
+          git add README.md
+          git commit --signoff -m "Sync README from master"
+          git push

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Community Code of Conduct
+
+This project follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+# Contributing Guidelines
+
+Contributions are welcome via GitHub pull requests. This document outlines the process to help get your contribution accepted.
+
+## Sign off Your Work
+
+The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project.
+Here is the full text of the [DCO](http://developercertificate.org/).
+Contributors must sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages.
+
+```text
+This is my commit message
+
+Signed-off-by: Random J Developer <[email protected]>
+```
+
+See `git help commit`:
+
+```text
+-s, --signoff
+    Add Signed-off-by line by the committer at the end of the commit log
+    message. The meaning of a signoff depends on the project, but it typically
+    certifies that committer has the rights to submit this work under the same
+    license and agrees to a Developer Certificate of Origin (see
+    http://developercertificate.org/ for more information).
+```
+
+## How to Contribute
+
+1. Fork this repository, develop, and test your changes
+1. Remember to sign off your commits as described above
+1. Submit a pull request
+
+***NOTE***: In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs.
+
+### Technical Requirements
+
+* Must pass [DCO check](#sign-off-your-work)
+* Must follow [Charts best practices](https://helm.sh/docs/topics/chart_best_practices/)
+* Must pass CI jobs for linting and installing changed charts with the [chart-testing](https://github.com/helm/chart-testing) tool
+* Any change to a chart requires a version bump following [semver](https://semver.org/) principles. See [Immutability](#immutability) and [Versioning](#versioning) below
+
+Once changes have been merged, the release job will automatically run to package and release changed charts.
+
+### Immutability
+
+Chart releases must be immutable. Any change to a chart warrants a chart version bump even if it is only changed to the documentation.
+
+### Versioning
+
+The chart `version` should follow [semver](https://semver.org/).
+
+Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to a chart should:
+
+1. Bump the MAJOR version
+2. In the README, under a section called "Upgrading", describe the manual steps necessary to upgrade to the new (specified) MAJOR version
+
+### Community Requirements
+
+This project is released with a [Contributor Covenant](https://www.contributor-covenant.org).
+By participating in this project you agree to abide by its terms.
+See [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md).

README.md

@@ -2,14 +2,26 @@
 
 A [Helm](https://helm.sh) chart to install [Zammad](https://zammad.org) on [Kubernetes](https://kubernetes.io)
 
-## Installation
+## Add the Helm repo via
 
-* https://docs.zammad.org/en/latest/install-kubernetes.html
+```console
+helm repo add zammad https://zammad.github.io/zammad-helm/
+```
 
-## Adding changes
+## Sources
 
-* Use a fork of this repo
-* Do NOT touch default (master) branch in any forks
-* Always create new branches to work on
-* Create a Github pull request and fill out the PR template
-* Follow Helm best practices: [https://docs.helm.sh/chart_best_practices](https://docs.helm.sh/chart_best_practices)
+The charts sources can be found here:
+
+* [https://github.com/zammad/zammad-helm](https://github.com/zammad/zammad-helm)
+
+The repo source can be found here:
+
+* [https://github.com/zammad/zammad-helm/tree/gh-pages](https://github.com/zammad/zammad-helm/tree/gh-pages)
+
+Helm Releases can be found here:
+
+* [https://github.com/zammad/zammad-helm/releases](https://github.com/zammad/zammad-helm/releases)
+
+## Adding changes to this repo
+
+See our [contrubuting guidelines](https://github.com/zammad/zammad-helm/blob/master/CONTRIBUTING.md).

zammad/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v1
 name: zammad
-version: 2.6.2
+version: 2.6.3
 appVersion: 3.5.0
 description: Zammad is a web based open source helpdesk/customer support system with many features to manage customer communication via several channels like telephone, facebook, twitter, chat and e-mails.
 home: https://zammad.org

zammad/README.md

@@ -30,7 +30,7 @@ The following table lists the configurable parameters of the zammad chart and th
 | Parameter                                          | Description                                      | Default                         |
 | -------------------------------------------------- | ------------------------------------------------ | ------------------------------- |
 | `image.repository`                                 | Container image to use                           | `zammad/zammad-docker-compose`  |
-| `image.tag`                                        | Container image tag to deploy                    | `3.5.0-5`                       |
+| `image.tag`                                        | Container image tag to deploy                    | `3.5.0-11`                       |
 | `image.pullPolicy`                                 | Container pull policy                            | `IfNotPresent`                  |
 | `image.imagePullSecrets`                           | An array of imagePullSecrets                     | `[]`                            |
 | `service.type`                                     | Service type                                     | `ClusterIP`                     |
@@ -77,7 +77,7 @@ The following table lists the configurable parameters of the zammad chart and th
 | `affinity`                                         | Affinity                                         | `{}`                            |
 | `elasticsearch.enabled`                            | Use Elasticsearch dependency                     | `true`                          |
 | `elasticsearch.image`                              | Elasticsearch docker image                       | `zammad/zammad-docker-compose`  |
-| `elasticsearch.imageTag`                           | Elasticsearch docker image tag                   | `zammad-elasticsearch-3.5.0-5`  |
+| `elasticsearch.imageTag`                           | Elasticsearch docker image tag                   | `zammad-elasticsearch-3.5.0-11`  |
 | `elasticsearch.clusterName`                        | Elasticsearch cluster name                       | `zammad`                        |
 | `elasticsearch.replicas`                           | Elasticsearch replicas                           | `1`                             |
 | `elasticsearch.clusterHealthCheckParams`           | Workaround to get ES test work in GitHubCI       | `"timeout=1s"`                  |

zammad/values.yaml

@@ -1,6 +1,6 @@
 image:
   repository: zammad/zammad-docker-compose
-  tag: 3.5.0-5
+  tag: 3.5.0-11
   pullPolicy: IfNotPresent
   imagePullSecrets: []
   # - name: "image-pull-secret"
@@ -160,7 +160,7 @@ affinity: {}
 elasticsearch:
   enabled: true
   image: "zammad/zammad-docker-compose"
-  imageTag: "zammad-elasticsearch-3.5.0-5"
+  imageTag: "zammad-elasticsearch-3.5.0-11"
   clusterName: zammad
   replicas: 1
   # Workaround to get helm test to work in GitHub action CI