Skip to content

Commit

Permalink
Enhance appearance on artifacthub (#846)
Browse files Browse the repository at this point in the history
  • Loading branch information
NotMyFault authored Apr 6, 2023
1 parent 789428f commit 8e32634
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 15 deletions.
6 changes: 0 additions & 6 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 0 additions & 3 deletions CODE_OF_CONDUCT.md

This file was deleted.

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/).
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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).

<!-- Keep full URL links to repo files because this README syncs from main to gh-pages. -->
Chart documentation is available in [jenkins directory](https://github.com/jenkinsci/helm-charts/blob/main/charts/jenkins/README.md).
Expand Down
7 changes: 7 additions & 0 deletions charts/jenkins/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion charts/jenkins/Chart.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -21,12 +21,18 @@ maintainers:
- name: timja
email: [email protected]
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
Expand All @@ -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"
11 changes: 8 additions & 3 deletions charts/jenkins/README.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 8e32634

Please sign in to comment.