Bitnami/charts
2
0
Fork 0
mirror of https://github.com/bitnami/charts.git synced 2026-02-10 20:27:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#2914)

Browse Source 
* Update CONTRIBUTING.md

* Update CONTRIBUTING.md

* Update CONTRIBUTING.md
This commit is contained in:
Carlos Rodríguez Hernández
2020-06-24 12:02:39 +02:00
committed by GitHub
parent dc009cd688
commit d1ca0595ff
1 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@@ -17,8 +17,7 @@ When submitting a PR make sure that it:
- Must pass CI jobs for linting and test the changes on top of different k8s platforms. (Automatically done by the Bitnami CI/CD pipeline).
- Must follow [Helm best practices](https://helm.sh/docs/chart_best_practices/).
- Implements changes in both files if the chart contains a _values-production.yaml_ and a _values.yaml_.
- Has the "edits and maintainers" option enabled to allow our CI/CD to modify the PR (`bitnami-bot` will update _values*.yaml_). Find more information in [this link](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
- Any change to a chart requires a version bump following [semver](https://semver.org/) principles.
- Any change to a chart requires a version bump following [semver](https://semver.org/) principles. This is the version that is going to be merged in the GitHub repository, then our CI/CD system is going to publish in the Helm registry a new patch version including your changes and the latest images and dependencies.
### Documentation Requirements
@@ -30,9 +29,11 @@ When submitting a PR make sure that it:
1. Changes are automatically linted and tested using the [`ct` tool](https://github.com/helm/chart-testing) as a [GitHub action](https://github.com/helm/chart-testing-action). Those tests are based on `helm install`, `helm lint` and `helm test` commands and provide quick feedback about the changes in the PR. For those tests, the chart is installed on top of [kind](https://github.com/kubernetes-sigs/kind) and this step is not blocking (as opposed to 3rd step).
2. Changes are manually reviewed by Bitnami team members.
3. Once the changes are accepted, the PR is tested into the Bitnami CI pipeline, the chart is installed and tested (verification and functional tests) on top of different k8s platforms.
4. If everything works fine, the `bitnami-bot` will add a new commit to the PR updating all the Docker images tags and dependencies. If something fails, the review process continues.
5. When the PR passes all tests it is merged in the GitHub master branch and the new version of the chart is pushed to the registry. Please note that may be a slight difference between the appearance of the code in GitHub and the chart in the registry.
3. Once the changes are accepted, the PR is tested (if needed) into the Bitnami CI pipeline, the chart is installed and tested (verification and functional tests) on top of different k8s platforms.
4. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub `master` branch.
5. Then our CI/CD system is going to push the chart to the Helm registry including the recently merged changes and also the latest images and dependencies used by the chart. The changes in the images will be also committed by the CI/CD to the GitHub repository, bumping the chart version again.
***NOTE***: Please note that, in terms of time, may be a slight difference between the appearance of the code in GitHub and the chart in the registry.
### Adding a new chart to the repository