diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5a0656944..a5723f2322 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -76,11 +76,10 @@ your PR will be rejected by the automated DCO check. This repository is used by Chart developers for maintaining the official charts for Kubernetes Helm. If your issue is in the Helm tool itself, please use the issue tracker in the [helm/helm](https://github.com/helm/helm) repository. -## How to Contribute a Chart +## How to Contribute to an existing Chart -1. Fork this repository, develop and test your Chart. Remember to sign off your commits as described in the "Sign Your Work" chapter. -1. Choose the correct folder for your chart based on the information in the [Repository Structure](README.md#repository-structure) section -1. Ensure your Chart follows the [technical](#technical-requirements) and [documentation](#documentation-requirements) guidelines, described below. +1. Fork this repository, develop and test your Chart changes. Remember to sign off your commits as described in the "Sign Your Work" chapter. +1. Ensure your Chart changes follow the [technical](#technical-requirements) and [documentation](#documentation-requirements) guidelines, described below. 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. @@ -121,7 +120,7 @@ This repository is used by Chart developers for maintaining the official charts ### Merge approval and release process -A Kubernetes Charts maintainer will review the Chart submission, and start a validation job in the CI to verify the technical requirements of the Chart. A maintainer may add "LGTM" (Looks Good To Me) or an equivalent comment to indicate that a PR is acceptable. Any change requires at least one LGTM. No pull requests can be merged until at least one maintainer signs off with an LGTM. +A Kubernetes Charts maintainer will review the Chart change submission, and start a validation job in the CI to verify the technical requirements of the Chart. A maintainer may add "LGTM" (Looks Good To Me) or an equivalent comment to indicate that a PR is acceptable. Any change requires at least one LGTM. No pull requests can be merged until at least one maintainer signs off with an LGTM. Once the Chart has been merged, the release job will automatically run in the CI to package and release the Chart in the [`gs://kubernetes-charts` Google Storage bucket](https://console.cloud.google.com/storage/browser/kubernetes-charts/). @@ -130,6 +129,7 @@ Once the Chart has been merged, the release job will automatically run in the CI Whether you are a user or contributor, official support channels include: - GitHub issues: https://github.com/helm/charts/issues +- Slack: Charts - #Charts room in the [Kubernetes Slack](http://slack.kubernetes.io/) - Slack: Helm Users - #Helm-users room in the [Kubernetes Slack](http://slack.kubernetes.io/) - Slack: Helm Developers - #Helm-dev room in the [Kubernetes Slack](http://slack.kubernetes.io/) diff --git a/README.md b/README.md index 628c87182e..809fa570c6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,27 @@ # Helm Charts -Use this repository to submit official Charts for Helm. Charts are curated application definitions for Helm. For more information about installing and using Helm, see its -[README.md](https://github.com/helm/helm/tree/master/README.md). To get a quick introduction to Charts see this [chart document](https://github.com/helm/helm/blob/master/docs/charts.md). +The canonical source for Helm charts is the [Helm Hub](https://hub.helm.sh/), an aggregator for distributed chart repos. + +This GitHub project is the source for Helm `stable` and `incubator` [Helm chart repositories](https://v3.helm.sh/docs/topics/chart_repository/), currently listed on the Hub. + +For more information about installing and using Helm, see the +[Helm Docs](https://helm.sh/docs/). For a quick introduction to Charts, see the [Chart Guide](https://helm.sh/docs/topics/charts/). + +## Status of the Project + +Similar to the [Helm 2 Support Plan](https://helm.sh/blog/2019-10-22-helm-2150-released/#helm-2-support-plan), this GitHub project has begun transition to a 1 year "maintenance mode" (see [Deprecation Timeline](#deprecation-timeline) below). Given the deprecation plan, this project is intended for [apiVersion: v1](https://helm.sh/docs/topics/charts/#the-apiversion-field) Charts (installable by both Helm 2 and 3), and not for `apiVersion: v2` charts (installable by Helm 3 only). + +### Deprecation Timeline + +| | | +| --- | --- | +| Nov 13, 2019 | At [Helm 3's public release](https://helm.sh/blog/helm-3-released/), new charts are no longer accepted to `stable` or `incubator`. Patches to existing charts may continue to be submitted by the community, and (time permitting) reviewed by chart OWNERS for acceptance | +| May 13, 2020 | At 6 months – when helm v2 goes security fix only – the `stable` and `incubator` repos will be de-listed from the Helm Hub. Chart OWNERS are encouraged to accept security fixes only | +| Nov 13, 2020 | At 1 year, support for this project will formally end, and this repo will be marked obsolete | + +This gives the community (chart OWNERS, organizations, groups or individuals who want to host charts) 6 months to move charts to new Helm repos, and list these new repos on the Helm Hub before `stable` and `incubator` are de-listed. + +Note that this project has been under active development for some time, so you might run into [issues](https://github.com/helm/charts/issues). If you do, please don't be shy about letting us know, or better yet, contribute a fix or feature (within the deprecation timeline of course). Also be aware the repo and chart OWNERS are volunteer so reviews are as time allows, and acceptance is up to the chart OWNERS - you may [reach out](#where-to-find-us) but please be patient and courteous. ## Where to find us @@ -51,9 +71,9 @@ Incubator Charts are those that do not meet these criteria. Having the incubator In order to get a Chart from incubator to stable, Chart maintainers should open a pull request that moves the chart folder. -## Contributing a Chart +## Contributing to an existing Chart -We'd love for you to contribute a Chart that provides a useful application or service for Kubernetes. Please read our [Contribution Guide](CONTRIBUTING.md) for more information on how you can contribute Charts. +We'd love for you to contribute to an existing Chart that you find provides a useful application or service for Kubernetes. Please read our [Contribution Guide](CONTRIBUTING.md) for more information on how you can contribute Charts. Note: We use the same [workflow](https://github.com/kubernetes/community/blob/master/contributors/devel/development.md#workflow), [License](LICENSE) and [Contributor License Agreement](CONTRIBUTING.md) as the main Kubernetes repository. @@ -96,10 +116,6 @@ This chart repository supports the latest and previous minor versions of Kuberne To provide that support the API versions of objects should be those that work for both the latest minor release and the previous one. -## Status of the Project - -This project is still under active development, so you might run into [issues](https://github.com/helm/charts/issues). If you do, please don't be shy about letting us know, or better yet, contribute a fix or feature. - ## Happy Helming in China If you are in China, there are some problems to use upstream Helm Charts directly (e.g. images hosted on `gcr.io`, `quay.io`, and Charts hosted on `googleapis.com` etc), you can use this mirror repo at https://github.com/cloudnativeapp/charts which automatically sync & replace unavailable image & repo URLs in every Chart.