diff --git a/.github/workflows/cd-pipeline.yml b/.github/workflows/cd-pipeline.yml index ec0b315a9..eb28a17ec 100644 --- a/.github/workflows/cd-pipeline.yml +++ b/.github/workflows/cd-pipeline.yml @@ -175,7 +175,7 @@ jobs: - uses: actions/download-artifact@v3 with: path: ~/artifacts - # If we perform a checkout of the master branch, we will find conflicts with the submodules + # If we perform a checkout of the main branch, we will find conflicts with the submodules - uses: actions/checkout@v3 with: ref: 'index' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b773d867b..cf5d26e91 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,7 +52,7 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will ### PR Approval and Release Process 1. Changes are manually reviewed by Bitnami team members. -1. Once the changes are accepted, the PR is verified with a [Static analysis](https://github.com/bitnami/charts/blob/master/TESTING.md#Static-analysis) that includes the lint and the vulnerability checks. If that passes, the Bitnami team will review the changes and trigger the verification and functional tests. +1. Once the changes are accepted, the PR is verified with a [Static analysis](https://github.com/bitnami/charts/blob/main/TESTING.md#Static-analysis) that includes the lint and the vulnerability checks. If that passes, the Bitnami team will review the changes and trigger the verification and functional tests. 1. When the PR passes all tests, the PR is merged by the reviewer(s) in the GitHub `master` branch. 1. 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. @@ -60,16 +60,16 @@ Notice the `Author` and `Signed-off-by` lines match. If they don't your PR will ### Testing -1. Read the [Test Strategy](https://github.com/bitnami/charts/blob/master/TESTING.md) guide. +1. Read the [Test Strategy](https://github.com/bitnami/charts/blob/main/TESTING.md) guide. 2. Determine the types of tests you will need based on the chart you are testing and the information in the test strategy. -3. Before you create a pull request, make sure you achieved the [Test Acceptance Criteria](https://github.com/bitnami/charts/blob/master/TESTING.md#Test-acceptance-criteria). +3. Before you create a pull request, make sure you achieved the [Test Acceptance Criteria](https://github.com/bitnami/charts/blob/main/TESTING.md#Test-acceptance-criteria). 4. If you were able to achieve them, congrats! Create a PR and wait for the approval. You should then be able to see the result of the test execution for multiple cloud platforms (AKS, TKG, GKE) after the approval. ### Adding a new chart to the repository There are three major technical requirements to add a new Helm chart to our catalog: - The chart should use Bitnami based container images. If they don't exist, you can [open a GitHub issue](https://github.com/bitnami/charts/issues/new/choose) and we will work together to create them. -- Follow the same structure/patterns that the rest of the Bitnami charts (you can find a basic scaffolding in the [`template` directory](https://github.com/bitnami/charts/tree/master/template)) and the [Best Practices for Creating Production-Ready Helm charts](https://docs.bitnami.com/tutorials/production-ready-charts/) guide. +- Follow the same structure/patterns that the rest of the Bitnami charts (you can find a basic scaffolding in the [`template` directory](https://github.com/bitnami/charts/tree/main/template)) and the [Best Practices for Creating Production-Ready Helm charts](https://docs.bitnami.com/tutorials/production-ready-charts/) guide. - Use an [OSI approved license](https://opensource.org/licenses) for all the software. Please, note we will need to check internally and evaluate the feasibility of adding the new solution to the catalog. Due to limited resources this step could take some time. diff --git a/README.md b/README.md index 1fdd60136..eb3d2533d 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Each Helm chart contains one or more containers. Those containers use images pro As part of the container releases, the images are scanned for vulnerabilities, [here](https://github.com/bitnami/containers#vulnerability-scan-in-bitnami-container-images) you can find more info about this topic. -Since the container image is an immutable artifact that is already analyzed, as part of the Helm chart release process we are not looking for vulnerabilities in the containers but running different verification to ensure the Helm charts work as expected, see the testing strategy defined at [_TESTING.md_](https://github.com/bitnami/charts/blob/master/TESTING.md). +Since the container image is an immutable artifact that is already analyzed, as part of the Helm chart release process we are not looking for vulnerabilities in the containers but running different verification to ensure the Helm charts work as expected, see the testing strategy defined at [_TESTING.md_](https://github.com/bitnami/charts/blob/main/TESTING.md). ## Before you begin diff --git a/TESTING.md b/TESTING.md index a667ea99d..1f143e0e7 100644 --- a/TESTING.md +++ b/TESTING.md @@ -8,7 +8,7 @@ The tests described here are _deployment_ tests since their goal is to verify th * The core asset features work properly when deployed * There are no regression bugs -Before writing any test scenario, understand the primary purpose of the chart. Take a look at [the documentation about the chart under test](https://github.com/bitnami/charts/tree/master/bitnami) as well as the [docker image documentation](https://github.com/bitnami?q=docker&type=all&language=&sort=). This will give you a solid base for creating valuable test scenarios. +Before writing any test scenario, understand the primary purpose of the chart. Take a look at [the documentation about the chart under test](https://github.com/bitnami/charts/tree/main/bitnami) as well as the [docker image documentation](https://github.com/bitnami?q=docker&type=all&language=&sort=). This will give you a solid base for creating valuable test scenarios. ## Common test cases diff --git a/bitnami/spring-cloud-dataflow/README.md b/bitnami/spring-cloud-dataflow/README.md index 9b3b9047c..f4097898e 100644 --- a/bitnami/spring-cloud-dataflow/README.md +++ b/bitnami/spring-cloud-dataflow/README.md @@ -7,7 +7,7 @@ Spring Cloud Data Flow is a microservices-based toolkit for building streaming a [Overview of Spring Cloud Data Flow](https://github.com/spring-cloud/spring-cloud-dataflow) - + ## TL;DR ```bash @@ -670,7 +670,7 @@ If you enabled RabbitMQ chart to be used as the messaging solution for Skipper t ### To 14.0.0 -This major updates the RabbitMQ subchart to its newest major, 11.0.0. [Here](https://github.com/bitnami/charts/tree/master/bitnami/rabbitmq#to-1100) you can find more information about the changes introduced in that version. +This major updates the RabbitMQ subchart to its newest major, 11.0.0. [Here](https://github.com/bitnami/charts/tree/main/bitnami/rabbitmq#to-1100) you can find more information about the changes introduced in that version. ### To 13.0.0 diff --git a/template/CHART_NAME/README.md b/template/CHART_NAME/README.md index 406c71aee..87c7bf105 100644 --- a/template/CHART_NAME/README.md +++ b/template/CHART_NAME/README.md @@ -99,7 +99,7 @@ externalDatabase.port=3306 %%IF NEEDED%% -This chart provides support for Ingress resources. If you have an ingress controller installed on your cluster, such as [nginx-ingress-controller](https://github.com/bitnami/charts/tree/master/bitnami/nginx-ingress-controller) or [contour](https://github.com/bitnami/charts/tree/master/bitnami/contour) you can utilize the ingress controller to serve your application. +This chart provides support for Ingress resources. If you have an ingress controller installed on your cluster, such as [nginx-ingress-controller](https://github.com/bitnami/charts/tree/main/bitnami/nginx-ingress-controller) or [contour](https://github.com/bitnami/charts/tree/main/bitnami/contour) you can utilize the ingress controller to serve your application. To enable Ingress integration, set `ingress.enabled` to `true`. The `ingress.hostname` property can be used to set the host name. The `ingress.tls` parameter can be used to add the TLS configuration for this host. It is also possible to have more than one host, with a separate TLS configuration for each host. [Learn more about configuring and using Ingress](https://docs.bitnami.com/kubernetes/apps/%%CHART_NAME%%/configuration/configure-use-ingress/). @@ -134,7 +134,7 @@ If additional containers are needed in the same pod as %%CHART_NAME%% (such as a This chart allows you to set your custom affinity using the `affinity` parameter. Find more information about Pod affinity in the [kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity). -As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the [bitnami/common](https://github.com/bitnami/charts/tree/master/bitnami/common#affinities) chart. To do so, set the `podAffinityPreset`, `podAntiAffinityPreset`, or `nodeAffinityPreset` parameters. +As an alternative, use one of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the [bitnami/common](https://github.com/bitnami/charts/tree/main/bitnami/common#affinities) chart. To do so, set the `podAffinityPreset`, `podAntiAffinityPreset`, or `nodeAffinityPreset` parameters. ## Troubleshooting diff --git a/template/CHART_NAME/values.yaml b/template/CHART_NAME/values.yaml index fd67b15c0..9a16f736c 100644 --- a/template/CHART_NAME/values.yaml +++ b/template/CHART_NAME/values.yaml @@ -705,7 +705,7 @@ metrics: ## relabelings: [] ## @param metrics.serviceMonitor.selector Prometheus instance selector labels - ## ref: https://github.com/bitnami/charts/tree/master/bitnami/prometheus-operator#prometheus-configuration + ## ref: https://github.com/bitnami/charts/tree/main/bitnami/prometheus-operator#prometheus-configuration ## selector: ## prometheus: my-prometheus ##