From 8e32634ebb06e3c87161cf93e6ab5e181f663baa Mon Sep 17 00:00:00 2001 From: Alexander Brandes Date: Thu, 6 Apr 2023 23:30:52 +0200 Subject: [PATCH] Enhance appearance on artifacthub (#846) --- .github/ISSUE_TEMPLATE/config.yml | 6 ------ CODE_OF_CONDUCT.md | 3 --- CONTRIBUTING.md | 2 +- README.md | 6 +++++- charts/jenkins/CHANGELOG.md | 7 +++++++ charts/jenkins/Chart.yaml | 10 +++++++++- charts/jenkins/README.md | 11 ++++++++--- 7 files changed, 30 insertions(+), 15 deletions(-) delete mode 100644 CODE_OF_CONDUCT.md diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 067446939..b152434f9 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -3,9 +3,3 @@ contact_links: - name: Community forum url: https://community.jenkins.io/ about: Please ask and answer questions here - - name: Report a security vulnerability - url: https://github.com/jenkinsci/helm-charts/security/policy - about: Please review our security policy for more details - - name: Mailing lists - url: https://www.jenkins.io/mailing-lists/ - about: You can also raise a question on the infra mailing list diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index bb6d572d7..000000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,3 +0,0 @@ -# Code of Conduct - -Jenkins Code of Conduct can be found [here](https://www.jenkins.io/project/conduct/). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8a3812e43..d622df16a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -100,4 +100,4 @@ Charts should start at `1.0.0`. Any breaking (backwards incompatible) changes to 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). +Visit our [code of conduct](https://www.jenkins.io/project/conduct/). diff --git a/README.md b/README.md index fd4c7ac40..dbf636a79 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # Jenkins Community Kubernetes Helm Charts +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/jenkins)](https://artifacthub.io/packages/helm/jenkinsci/jenkins) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Releases downloads](https://img.shields.io/github/downloads/jenkinsci/helm-charts/total.svg)](https://github.com/jenkinsci/helm-charts/releases) +[![Join the chat at https://app.gitter.im/#/room/#jenkins-ci:matrix.org](https://badges.gitter.im/badge.svg)](https://app.gitter.im/#/room/#jenkins-ci:matrix.org) The code is provided as-is with no warranties. @@ -13,9 +16,10 @@ Once Helm is set up properly, add the repository as follows: ```console helm repo add jenkins https://charts.jenkins.io +helm repo update ``` -You can then run `helm search repo jenkins` to see the charts. +You can then run `helm search repo jenkins` to see the charts or obtain an exhaustive list of releases from [GitHub releases](https://github.com/jenkinsci/helm-charts/releases). Chart documentation is available in [jenkins directory](https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/README.md). diff --git a/charts/jenkins/CHANGELOG.md b/charts/jenkins/CHANGELOG.md index e22de63c9..ec8d119e4 100644 --- a/charts/jenkins/CHANGELOG.md +++ b/charts/jenkins/CHANGELOG.md @@ -12,7 +12,14 @@ Use the following links to reference issues, PRs, and commits prior to v2.6.0. The changelog 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. +## 4.3.20 + + +Enhance repository appearance and miscellaneous cleanup. + ## 4.3.19 + + Comply with superlinter rules and address ShellCheck issues. ## 4.3.18 diff --git a/charts/jenkins/Chart.yaml b/charts/jenkins/Chart.yaml index d6c391316..3d464e8d4 100644 --- a/charts/jenkins/Chart.yaml +++ b/charts/jenkins/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v2 name: jenkins home: https://jenkins.io/ -version: 4.3.19 +version: 4.3.20 appVersion: 2.387.2 description: Jenkins - Build great things at any scale! The leading open source automation server, Jenkins provides hundreds of plugins to support building, deploying and automating any project. sources: @@ -21,12 +21,18 @@ maintainers: - name: timja email: timjacomb1@gmail.com icon: https://get.jenkins.io/art/jenkins-logo/logo.svg +keywords: + - jenkins + - ci + - devops annotations: artifacthub.io/links: | - name: Chart Source url: https://github.com/jenkinsci/helm-charts/tree/main/charts/jenkins - name: Jenkins url: https://www.jenkins.io/ + - name: support + url: https://github.com/jenkinsci/helm-charts/issues artifacthub.io/images: | - name: jenkins image: jenkins/jenkins:2.387.2-jdk11 @@ -36,3 +42,5 @@ annotations: image: jenkins/inbound-agent:3107.v665000b_51092-5 - name: backup image: maorfr/kube-tasks:0.2.0 + artifacthub.io/category: "integration-delivery" + artifacthub.io/license: "Apache-2.0" diff --git a/charts/jenkins/README.md b/charts/jenkins/README.md index d51f29f4e..60365c70c 100644 --- a/charts/jenkins/README.md +++ b/charts/jenkins/README.md @@ -1,5 +1,10 @@ # Jenkins +[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/jenkins)](https://artifacthub.io/packages/helm/jenkinsci/jenkins) +[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +[![Releases downloads](https://img.shields.io/github/downloads/jenkinsci/helm-charts/total.svg)](https://github.com/jenkinsci/helm-charts/releases) +[![Join the chat at https://app.gitter.im/#/room/#jenkins-ci:matrix.org](https://badges.gitter.im/badge.svg)](https://app.gitter.im/#/room/#jenkins-ci:matrix.org) + [Jenkins](https://www.jenkins.io/) is the leading open source automation server, Jenkins provides hundreds of plugins to support building, deploying and automating any project. This chart installs a Jenkins server which spawns agents on [Kubernetes](http://kubernetes.io) utilizing the [Jenkins Kubernetes plugin](https://plugins.jenkins.io/kubernetes/). @@ -46,20 +51,20 @@ $ helm upgrade [RELEASE_NAME] jenkins/jenkins [flags] _See [helm upgrade](https://helm.sh/docs/helm/helm_upgrade/) for command documentation._ -Visit the chart's [CHANGELOG](./CHANGELOG.md) to view the chart's release history. +Visit the chart's [CHANGELOG](https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/CHANGELOG.md) to view the chart's release history. For migration between major version check [migration guide](#migration-guide). ## Configuration See [Customizing the Chart Before Installing](https://helm.sh/docs/intro/using_helm/#customizing-the-chart-before-installing). -To see all configurable options with detailed comments, visit the chart's [values.yaml](./values.yaml), or run these configuration commands: +To see all configurable options with detailed comments, visit the chart's [values.yaml](https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/values.yaml), or run these configuration commands: ```console # Helm 3 $ helm show values jenkins/jenkins ``` -For a summary of all configurable options, see [VALUES_SUMMARY.md](./VALUES_SUMMARY.md) +For a summary of all configurable options, see [VALUES_SUMMARY.md](https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/VALUES_SUMMARY.md). ### Configure Security Realm and Authorization Strategy