Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Add re-generation of Helm docs to release #477

Merged
merged 1 commit into from
Jun 22, 2023
Merged

chore: Add re-generation of Helm docs to release #477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@ Thanks for helping making KEDA better!
You can easily release a new Helm chart version:

1. Update the version of the Helm chart in `Chart.yaml`.
2. Package the Helm chart
2. Re-generate the Helm chart docs ([learn more](#documentation))
3. Package the Helm chart
- For KEDA:
```shell
$ helm package keda --destination docs
Expand All @@ -23,19 +24,19 @@ You can easily release a new Helm chart version:
$ helm package external-scaler-azure-cosmos-db --destination docs
Successfully packaged chart and saved it to: docs/external-scaler-azure-cosmos-db-0.1.0.tgz
```
3. Re-index the Helm repo to add our new version:
4. Re-index the Helm repo to add our new version:
```shell
$ helm repo index docs --url https://kedacore.github.io/charts
```
4. Update the version in the "Browse all our Helm charts" section of our README.md
5. Commit changes:
5. Update the version in the "Browse all our Helm charts" section of our README.md
6. Commit changes:
```shell
git add .
git commit -sm "Packaged new Helm chart version"
git push origin chart-release
```
6. Create a pull request with our new Helm index.
7. Create a GitHub release for your new Helm chart version by using the following template.
7. Create a pull request with our new Helm index.
8. Create a GitHub release for your new Helm chart version by using the following template.
- Make sure to list the changes to our Helm chart which are tracked in the [KEDA Core vNext](https://github.com/kedacore/charts/milestone/10) milestone
- Instead of listing all KEDA core changes, simply refer to our release notes on the other repo (see template)

Expand Down Expand Up @@ -69,8 +70,8 @@ You can easily release a new Helm chart version:
>
> - {{List removed features}}

8. Create a new milestone called `KEDA Core v{version}`
9. Move the closed items from `KEDA Core vNext` to the new milestone and close it
9. Create a new milestone called `KEDA Core v{version}`
10. Move the closed items from `KEDA Core vNext` to the new milestone and close it

## Developer Certificate of Origin: Signing your work

Expand Down
11 changes: 10 additions & 1 deletion http-add-on/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,6 @@ their default values.
{{- end }}
{{- end }}


### Operator

| Parameter | Type | Default | Description |
Expand Down Expand Up @@ -121,6 +120,16 @@ their default values.
{{- end }}
{{- end }}

### Webhooks

| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
{{- range .Values }}
{{- if hasPrefix "webhooks" .Key }}
| `{{ .Key }}` | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} |
{{- end }}
{{- end }}

Specify each parameter using the `--set key=value[,key=value]` argument to
`helm install`. For example:

Expand Down
3 changes: 3 additions & 0 deletions keda/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,8 +239,11 @@ their default values.
| `webhooks.affinity` | object | `{}` | [Affinity] for pod scheduling for KEDA admission webhooks. Takes precedence over the `affinity` field |
| `webhooks.enabled` | bool | `true` | Enable admission webhooks (this feature option will be removed in v2.12) |
| `webhooks.failurePolicy` | string | `"Ignore"` | [Failure policy](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#failure-policy) to use with KEDA admission webhooks |
| `webhooks.healthProbePort` | int | `8081` | Port number to use for KEDA admission webhooks health probe |
| `webhooks.name` | string | `"keda-admission-webhooks"` | Name of the KEDA admission webhooks |
| `webhooks.port` | string | `""` | Port number to use for KEDA admission webhooks. Default is 9443. |
| `webhooks.replicaCount` | int | `1` | Capability to configure the number of replicas for KEDA admission webhooks |
| `webhooks.useHostNetwork` | bool | `false` | Enable webhook to use host network, this is required on EKS with custom CNI |

Specify each parameter using the `--set key=value[,key=value]` argument to
`helm install`. For example:
Expand Down
1 change: 0 additions & 1 deletion keda/README.md.gotmpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ their default values.
{{- end }}
{{- end }}


### Operator

| Parameter | Type | Default | Description |
Expand Down
Loading