Skip to content
This repository was archived by the owner on Sep 14, 2024. It is now read-only.

Commit fd54977

Browse files
scottrigbyk8s-ci-robot
authored andcommitted
Update README to change k8s member step (helm#6779)
* After repo move to helm/helm, update steps for Owning and Maintaining A Chart * Change repo URL from kubernetes/helm to helm/helm everywhere above chart directories (those may be separate PRs) * Fix earlier missing apostrophe and incorrect case * Add missing k8s/ > helm/ string changes
1 parent f7cfc02 commit fd54977

File tree

7 files changed

+19
-19
lines changed

7 files changed

+19
-19
lines changed

.circleci/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
- run:
2121
name: lint
2222
command: |
23-
git remote add k8s https://github.com/kubernetes/charts
23+
git remote add k8s https://github.com/helm/charts
2424
git fetch k8s master
2525
chart_test.sh --config test/.testenv --no-install
2626
sync:

.github/PULL_REQUEST_TEMPLATE.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
<!--
2-
Thank you for contributing to kubernetes/charts. Before you submit this PR we'd like to
2+
Thank you for contributing to helm/charts. Before you submit this PR we'd like to
33
make sure you are aware of our technical requirements and best practices:
44
5-
* https://github.com/kubernetes/charts/blob/master/CONTRIBUTING.md#technical-requirements
6-
* https://github.com/kubernetes/helm/tree/master/docs/chart_best_practices
5+
* https://github.com/helm/charts/blob/master/CONTRIBUTING.md#technical-requirements
6+
* https://github.com/helm/helm/tree/master/docs/chart_best_practices
77
88
For a quick overview across what we will look at reviewing your PR, please read
99
our review guidelines:
1010
11-
* https://github.com/kubernetes/charts/blob/master/REVIEW_GUIDELINES.md
11+
* https://github.com/helm/charts/blob/master/REVIEW_GUIDELINES.md
1212
1313
Following our best practices right from the start will accelerate the review process and
1414
help get your PR merged quicker.

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This repository is used by Chart developers for maintaining the official charts
3434
* All Chart dependencies should also be submitted independently
3535
* Must pass the linter (`helm lint`)
3636
* Must successfully launch with default values (`helm install .`)
37-
* All pods go to the running state (or NOTES.txt provides further instructions if a required value is missing e.g. [minecraft](https://github.com/kubernetes/charts/blob/master/stable/minecraft/templates/NOTES.txt#L3))
37+
* All pods go to the running state (or NOTES.txt provides further instructions if a required value is missing e.g. [minecraft](https://github.com/helm/charts/blob/master/stable/minecraft/templates/NOTES.txt#L3))
3838
* All services have at least one endpoint
3939
* Must include source GitHub repositories for images used in the Chart
4040
* Images should not have any major security vulnerabilities
@@ -73,7 +73,7 @@ Once the Chart has been merged, the release job will automatically run in the CI
7373

7474
Whether you are a user or contributor, official support channels include:
7575

76-
- GitHub issues: https://github.com/kubernetes/charts/issues
76+
- GitHub issues: https://github.com/helm/charts/issues
7777
- Slack: Helm Users - #Helm-users room in the [Kubernetes Slack](http://slack.kubernetes.io/)
7878
- Slack: Helm Developers - #Helm-dev room in the [Kubernetes Slack](http://slack.kubernetes.io/)
7979

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -60,18 +60,18 @@ Note: We use the same [workflow](https://github.com/kubernetes/community/blob/ma
6060

6161
## Owning and Maintaining A Chart
6262

63-
Individual charts can be maintained by one or more members of the Kubernetes community. When someone maintains a chart they have the access to merge changes to that chart. To have merge access to a chart someone first needs to be listed on the chart, in the `Chart.yaml` file, as a maintainer. If that is the case there are two steps that need to happen:
63+
Individual charts can be maintained by one or more members of the Kubernetes community. When someone maintains a chart they have the access to merge changes to that chart. To have merge access to a chart someone needs to:
6464

65-
1. Become a [member of the Kubernetes community](https://github.com/kubernetes/community/blob/master/community-membership.md). If you need sponsors and have contributed to charts please reach out to one of the [OWNERS](OWNERS) of the charts repository.
66-
2. An OWNERS file needs to be added to a chart. That OWNERS file should list the maintainers GitHub Login names for both the reviewers and approvers sections. For an example see the [Drupal chart](stable/drupal/OWNERS). The `OWNERS` file should also be appended to the `.helmignore` file.
65+
1. Be listed on the chart, in the `Chart.yaml` file, as a maintainer. If you need sponsors and have contributed to the chart, please reach out to the existing maintainers, or if you are having trouble connecting with them, please reach out to one of the [OWNERS](OWNERS) of the charts repository.
66+
1. Be invited (and accept your invite) as a read-only collaborator on [this repo](https://github.com/helm/charts). This is required for @k8s-ci-robot [PR comment interaction](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md).
67+
1. An OWNERS file needs to be added to a chart. That OWNERS file should list the maintainers' GitHub login names for both the reviewers and approvers sections. For an example see the [Drupal chart](stable/drupal/OWNERS). The `OWNERS` file should also be appended to the `.helmignore` file.
6768

6869
Once these two steps are done a chart approver can merge pull requests following the directions in the [REVIEW_GUIDELINES.md](REVIEW_GUIDELINES.md) file.
6970

7071
## Review Process
7172

7273
For information related to the review procedure used by the Chart repository maintainers, see [Merge approval and release process](CONTRIBUTING.md#merge-approval-and-release-process).
7374

74-
7575
### Stale Pull Requests and Issues
7676

7777
Pull Requests and Issues that have no activity for 30 days automatically become stale. After 30 days of being stale, without activity, they become rotten. Pull Requests and Issues can rot for 30 days and then they are automatically closed. This is the standard stale process handling for all repositories on the Kubernetes GitHub organization.

REVIEW_GUIDELINES.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Chart Review Guidelines
22

3-
Anyone is welcome to review pull requests. Besides our [technical requirements](https://github.com/kubernetes/charts/blob/master/CONTRIBUTING.md#technical-requirements) and [best practices](https://github.com/kubernetes/helm/tree/master/docs/chart_best_practices), here's an overview of process and review guidelines.
3+
Anyone is welcome to review pull requests. Besides our [technical requirements](https://github.com/helm/charts/blob/master/CONTRIBUTING.md#technical-requirements) and [best practices](https://github.com/kubernetes/helm/tree/master/docs/chart_best_practices), here's an overview of process and review guidelines.
44

55
## Process
66

7-
The process to get a pull request merged is fairly simple. First, all required tests need to pass and the contributor needs to have a signed CLA. See [Charts Testing](https://github.com/kubernetes/charts/blob/master/test/README.md) for details on our CI system and how you can provide custom values for testing. If there is a problem with some part of the test, such as a timeout issue, please contact one of the charts repository maintainers by commenting `cc @kubernetes/charts-maintainers`.
7+
The process to get a pull request merged is fairly simple. First, all required tests need to pass and the contributor needs to have a signed CLA. See [Charts Testing](https://github.com/helm/charts/blob/master/test/README.md) for details on our CI system and how you can provide custom values for testing. If there is a problem with some part of the test, such as a timeout issue, please contact one of the charts repository maintainers by commenting `cc @kubernetes/charts-maintainers`.
88

99
The charts repository uses the OWNERS files to provide merge access. If a chart has an OWNERS file, an approver listed in that file can approve the pull request. If the chart does not have an OWNERS file, an approver in the OWNERS file at the root of the repository can approve the pull request.
1010

test/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Pull requests testing is run via the [Kubernetes Test Infrastructure](https://gi
2525

2626
The configuration of the Pull Request trigger is [in the config.json](https://github.com/kubernetes/test-infra/blob/827797c54b48295045698465b437f463ca9276c2/jobs/config.json#L10285).
2727

28-
This snippet tells Test Infra to run the [test/e2e.sh](https://github.com/kubernetes/charts/blob/master/test/e2e.sh)
29-
when testing is triggered on a pull request. The e2e.sh script will use the [Charts test image](https://github.com/kubernetes/charts/blob/master/test/Dockerfile)
28+
This snippet tells Test Infra to run the [test/e2e.sh](https://github.com/helm/charts/blob/master/test/e2e.sh)
29+
when testing is triggered on a pull request. The e2e.sh script will use the [Charts test image](https://github.com/helm/charts/blob/master/test/Dockerfile)
3030
to run the [chart_test.sh](https://github.com/kubernetes-helm/chart-testing/blob/master/chart_test.sh) script. This script
3131
is the main logic for validation of a pull request. It intends to only test charts that have changed in this PR.
3232

@@ -52,11 +52,11 @@ This check is there to ensure that PRs are spot checked for any nefarious code.
5252
## Repo Syncing
5353

5454
The syncing of charts to the stable and incubator repos happens from a Jenkins instance that is polling for changes
55-
to the master branch. On each change it will use the [test/repo-sync.sh](https://github.com/kubernetes/charts/blob/master/test/repo-sync.sh)
55+
to the master branch. On each change it will use the [test/repo-sync.sh](https://github.com/helm/charts/blob/master/test/repo-sync.sh)
5656
to update the public repositories. The procedure is as follows:
5757

58-
1. [Setup Helm](https://github.com/kubernetes/charts/blob/master/test/repo-sync.sh#L16)
59-
1. [Authenticate to Google Cloud so that we can upload to the Cloud Storage bucket that hosts the charts](https://github.com/kubernetes/charts/blob/master/test/repo-sync.sh#L27)
58+
1. [Setup Helm](https://github.com/helm/charts/blob/master/test/repo-sync.sh#L16)
59+
1. [Authenticate to Google Cloud so that we can upload to the Cloud Storage bucket that hosts the charts](https://github.com/helm/charts/blob/master/test/repo-sync.sh#L27)
6060
1. For the stable and incubator folders:
6161
- Download the existing index.yaml from the repository
6262
- Run `helm dep build` on all the charts in the current repository

test/e2e.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ fi
3333
readonly PULL_INFO
3434

3535
main() {
36-
git remote add k8s https://github.com/kubernetes/charts
36+
git remote add k8s https://github.com/helm/charts
3737
git fetch k8s master
3838

3939
local config_container_id

0 commit comments

Comments
 (0)