Merge pull request #1 from torstenwalter/add-readme

First release of helm chart in new location

Author: torstenwalter

.github/workflows/linter.yml

@@ -0,0 +1,21 @@
+name: Lint Code Base
+
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+
+on: pull_request
+
+jobs:
+  build:
+    name: Lint Code Base
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v2
+      - name: Lint Code Base
+        uses: github/super-linter@v3
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_YAML: false
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Code of Conduct
+
+Jenkins Code of Conduct can be found [here](https://www.jenkins.io/project/conduct/).

CONTRIBUTING.md

@@ -0,0 +1,60 @@
+# 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 a change 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

@@ -0,0 +1,28 @@
+# Jenkins Community Kubernetes Helm Charts
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+The code is provided as-is with no warranties.
+
+## Usage
+
+[Helm](https://helm.sh) must be installed to use the charts.
+Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
+
+Once Helm is set up properly, add the repo as follows:
+
+```console
+helm repo add jenkinsci https://charts.jenkins.io
+```
+
+You can then run `helm search repo jenkinsci` to see the charts.
+
+Chart documentation is available in [jenkins directory](./charts/jenkins/README.md).
+
+## Contributing
+
+We'd love to have you contribute! Please refer to our [contribution guidelines](CONTRIBUTING.md) for details.
+
+## License
+
+[Apache 2.0 License](./LICENSE).

charts/jenkins/CHANGELOG.md

@@ -1,9 +1,18 @@
 # Change Log
 
-This file documents all notable changes to Jenkins Helm Chart. The release
-numbering uses [semantic versioning](http://semver.org).
+This file documents all notable changes to the Jenkins Helm Chart.
+The release numbering uses [semantic versioning](http://semver.org).
 
-NOTE: The change log until version 1.5.7 is auto generated based on git commits. Those include a reference to the git commit to be able to get more details.
+Use the following links to reference issues, PRs, and commits prior to v2.6.0.
+* Issue:  `https://github.com/helm/charts/issues/[issue#]`
+* PR:     `https://github.com/helm/charts/pull/[pr#]`
+* Commit: `https://github.com/helm/charts/commit/[commit]/stable/jenkins`
+
+The change log until v1.5.7 was auto-generated based on git commits. Those entries include a reference to the git commit to be able to get more details.
+
+## 2.6.0 First release in jenkinsci GitHub org
+
+Updated README for new location
 
 ## 2.5.2
 
@@ -49,7 +58,7 @@ Add an option to specify pod based on labels that can connect to master if Netwo
 ## 2.2.0 increase retry for config auto reload
 
 Configure `REQ_RETRY_CONNECT` to `10` to give Jenkins more time to start up.
-https://github.com/kiwigrid/k8s-sidecar
+<https://github.com/kiwigrid/k8s-sidecar>
 
 Value can be configured via `master.sidecars.configAutoReload.reqRetryConnect`
 
@@ -127,13 +136,13 @@ Add support for overriding Ingress paths via `master.ingress.paths`
 
 ## 1.20.0
 
-  Add the following options for configuring the Kubernetes plugin.
+Add the following options for configuring the Kubernetes plugin.
 
- - master.slaveDefaultsProviderTemplate
- - master.slaveJenkinsUrl
- - master.slaveJenkinsTunnel
- - master.slaveConnectTimeout
- - master.slaveReadTimeout
+- master.slaveDefaultsProviderTemplate
+- master.slaveJenkinsUrl
+- master.slaveJenkinsTunnel
+- master.slaveConnectTimeout
+- master.slaveReadTimeout
 
 ## 1.19.0
 
@@ -265,7 +274,7 @@ Update docs for Helm 3
 
 Make `jenkins-home` attachable to Azure Disks without pvc
 
-```
+```yaml
  volumes:
   - name: jenkins-home
     azureDisk:
@@ -313,7 +322,7 @@ configuration-as-code | 1.27        | 1.32
 
 ## 1.9.6
 
-Enables jenkins to use keystore inorder to have native ssl support [#17790](https: https://wiki.jenkins.io/pages/viewpage.action?pageId=135468777)
+Enables jenkins to use keystore inorder to have native ssl support #17790 <https://wiki.jenkins.io/pages/viewpage.action?pageId=135468777>
 
 ## 1.9.5 Enable remoting security
 
@@ -323,7 +332,7 @@ Enables jenkins to use keystore inorder to have native ssl support [#17790](http
 
 Google application credentials are kept in a file, which has to be mounted to a pod. You can set `gcpcredentials` in `existingSecret` as follows:
 
-```
+```yaml
  existingSecret:
     jenkins-service-account:
       gcpcredentials: application_default_credentials.json
@@ -472,7 +481,7 @@ JCasC default configuration includes:
 
 Example `values.yaml` which enables JCasC, it's default config and configAutoReload:
 
-```
+```yaml
 master:
   JCasC:
     enabled: true
@@ -742,24 +751,24 @@ commit: 48c58a430
 helm chart best practices (#13136)
 commit: b02ae3f48
 
-### Breaking changes:
+### Breaking changes
 
 - values have been renamed to follow helm chart best practices for naming conventions so
   that all variables start with a lowercase letter and words are separated with camelcase
-  https://helm.sh/docs/chart_best_practices/#naming-conventions
+  <https://helm.sh/docs/chart_best_practices/#naming-conventions>
 - all resources are now using recommended standard labels
-  https://helm.sh/docs/chart_best_practices/#standard-labels
+  <https://helm.sh/docs/chart_best_practices/#standard-labels>
 
 As a result of the label changes also the selectors of the deployment have been updated.
 Those are immutable so trying an updated will cause an error like:
 
-```
+```text
 Error: Deployment.apps "jenkins" is invalid: spec.selector: Invalid value: v1.LabelSelector{MatchLabels:map[string]string{"app.kubernetes.io/component":"jenkins-master", "app.kubernetes.io/instance":"jenkins"}, MatchExpressions:[]v1.LabelSelectorRequirement(nil)}: field is immutable
 ```
 
 In order to upgrade, delete the Jenkins Deployment before upgrading:
 
-```
+```console
 kubectl delete deploy jenkins
 ```
 
@@ -1328,13 +1337,9 @@ commit: e3e617a0b
 Merge branch 'master' into jenkins-test-timeout
 commit: 9a230a6b1
 
-## 0.8.1
-
 Double retry count for Jenkins test
 commit: 129c8e824
 
-## 0.10.1
-
 Jenkins: Update README | Master.ServiceAnnotations (#2757)
 commit: 6571810bc
 
@@ -1358,8 +1363,6 @@ commit: d044f99be
 Review jenkins networkpolicy docs (#2618)
 commit: 49911e458
 
-## 0.9.2
-
 Add image pull secrets to jenkins templates (#1389)
 commit: 4dfae21fd
 
@@ -1368,23 +1371,19 @@ commit: 4dfae21fd
 Added persistent volume claim annotations (#2619)
 commit: ac9e5306e
 
-## 0.9.1
-
 Fix failing CI lint (#2758)
 commit: 26f709f0e
 
 ## 0.9.0
 
-#1785 namespace defined templates with chart name (#2140)
+namespace defined templates with chart name (#2140)
 commit: 408ae0b3f
 
 ## 0.8.9
 
 added useSecurity and adminUser to params (#1903)
 commit: 39d2a03cd
 
-## 0.8.9
-
 Use storageClassName for jenkins. (#1997)
 commit: 802f6449b
 
@@ -1393,8 +1392,6 @@ commit: 802f6449b
 Remove old plugin locks before installing plugins (#1746)
 commit: 6cd7b8ff4
 
-## 0.8.8
-
 promote initContainrs to podspec (#1740)
 commit: fecc804fc
 
@@ -1428,8 +1425,6 @@ commit: 0dc349b44
 Remove path from ingress specification to allow other paths (#1599)
 commit: e727f6b32
 
-## 0.8.2
-
 Update git plugin to 3.4.0 for CVE-2017-1000084 (#1505)
 commit: 03482f995
 
@@ -1438,8 +1433,6 @@ commit: 03482f995
 Use consistent whitespace in template placeholders (#1437)
 commit: 912f50c71
 
-## 0.8.1
-
 add configurable service annotations #1234 (#1244)
 commit: 286861ca8
 
@@ -1558,8 +1551,6 @@ commit: 6fc0ff242
 Changed default value of Kubernetes Cloud name to match one in kubernetes plugin (#404)
 commit: 68351304a
 
-## 0.1.10
-
 Add support for overriding the Jenkins ConfigMap (#524)
 commit: f97ca53b1
 
@@ -1573,18 +1564,12 @@ commit: d76a09588
 Change description (#553)
 commit: 91f5c24e1
 
-## 0.1.8
-
 Removed default Persistence.StorageClass: generic (#530)
 commit: c87494c10
 
-## 0.1.8
-
 Update to the recommended pvc patterns. (#448)
 commit: a7fc595aa
 
-## 0.1.8
-
 Remove helm.sh/created annotations (#505)
 commit: f380da2fb
 
@@ -1593,13 +1578,9 @@ commit: f380da2fb
 add support for explicit NodePort on jenkins chart (#342)
 commit: f63c188da
 
-## 0.1.7
-
 Add configurable loadBalancerSourceRanges for jenkins chart (#360)
 commit: 44007c50e
 
-## 0.1.7
-
 Update Jenkins version to current LTS (2.19.4) and Kubernetes Plugin to 0.10 (#341)
 commit: 6c8678167
 
@@ -1618,18 +1599,12 @@ commit: 4aa9cf5b1
 removed `*` from `jenkins/templates/NOTES.txt`
 commit: 76212230b
 
-## 0.1.4
-
 apply standard metadata labels to PVC's
 commit: 58b730836
 
-## 0.1.4
-
 specify namespace in `kubectl get svc` commands in NOTES.txt
 commit: 7d3287e81
 
-## 0.1.4
-
 Update Jenkins version to current LTS (#194)
 commit: 2c0404049
 
@@ -1638,23 +1613,15 @@ commit: 2c0404049
 escape fixed
 commit: 2026e1d15
 
-## 0.1.1
-
 .status.loadBalancer.ingress[0].ip is empty in AWS
 commit: 1810e37f4
 
-## 0.1.1
-
 .status.loadBalancer.ingress[0].ip is empty in AWS
 commit: 3cbd3ced6
 
-## 0.1.1
-
 Remove 'Getting Started:' from various NOTES.txt. (#181)
 commit: 2f63fd524
 
-## 0.1.1
-
 docs(\*): update READMEs to reference chart repos (#119)
 commit: c7d1bff05