changes for release v1.1.1 #8125
Conversation
k8s-ci-robot
added
cncf-cla: yes
|
@longwuyuan: This issue is currently awaiting triage. If Ingress contributors determines this is a relevant issue, they will accept it by applying the The Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
needs-kind
|
/retest |
|
/remove-area docs |
|
Please fix the lint errors. Thanks! |
|
hi @sc250024 , I don't see a test in your helm-docs implementation PR so could not dig deeper. But helm-docs is failing in the CI pipeline, during the release process. Looks like a parsing error while creating the table that lists the variables https://github.com/kubernetes/ingress-nginx/runs/4769824158?check_suite_focus=true |
|
you should be running |
@tao12345666333 the CI failed even afterI have run helm-docs locally and commited the modified charts/ingress-nginx/README.md . The pipeline failure message shows that helm-docs completes the autogeneration, but it looks like it does not know what to do with the new autogenerated README and so crashes. |
|
and now I am curious why helm-docs should be in the CI pipeline ? If we are running helm-docs locally, then there is no need for the CI to run it. |
It can be seen that some content has not been updated |
For precisely the reason in this comment: #8125 (comment) . The docs are out of sync with each other. |
(1) The charts/ingress-nginx/READMEmd in the repo's main branch and the README.md that I am checking-in, after I have executed helm-docs on my laptop (in the clone of my fork) will never be the same ever. So if that diff is between the file in the repo and the file that I am checking-in, they will always be different, at least on this first iteration, since the helm-docs PR was merged. Do I understand this correctly ? Please help me understand this precisely what you mean by referring to the statement "some content has not been updated" . Once I have understood, I can fix the CI error. (2) Even without any complications and errors, the simple fact that I have already used the executable |
The ingress-nginx/.github/workflows/ci.yaml Line 144 in a17181e simply checks if the It does this because the The CI script is not attempting to commit back the changes, nor should it. It's simply telling you "Hey, you've made changes to the You might want to try running $ git remote -v
origin git@github.com:longwuyuan/ingress-nginx.git (fetch)
origin git@github.com:longwuyuan/ingress-nginx.git (push)
$ git branch
* 8123
main
$ git rev-parse --short HEAD
a86d258c9
$ GOBIN=$PWD GO111MODULE=on go install github.com/norwoodj/helm-docs/cmd/helm-docs@v1.6.0
$ ./helm-docs --chart-search-root=${PWD}/charts
INFO[2022-01-11T07:18:34+01:00] Found Chart directories [ingress-nginx]
INFO[2022-01-11T07:18:34+01:00] Generating README Documentation for chart /path/to/git-repo/longwuyuan--ingress-nginx/charts/ingress-nginx
$ git diff --exit-code > /dev/null
$ echo $?
1This means that not all of the changes that should be in the helm-docs-changes.patchdiff --git i/charts/ingress-nginx/README.md w/charts/ingress-nginx/README.md
index 4c2d9bdbf..32dfd36e2 100644
--- i/charts/ingress-nginx/README.md
+++ w/charts/ingress-nginx/README.md
@@ -343,7 +343,7 @@ Kubernetes: `>=1.19.0-0`
| controller.metrics.prometheusRule.enabled | bool | `false` | |
| controller.metrics.prometheusRule.rules | list | `[]` | |
| controller.metrics.service.annotations | object | `{}` | |
-| controller.metrics.service.externalIPs | list | `[]` | |
+| controller.metrics.service.externalIPs | list | `[]` | List of IP addresses at which the stats-exporter service is available |
| controller.metrics.service.loadBalancerSourceRanges | list | `[]` | |
| controller.metrics.service.servicePort | int | `10254` | |
| controller.metrics.service.type | string | `"ClusterIP"` | |
@@ -391,9 +391,9 @@ Kubernetes: `>=1.19.0-0`
| controller.service.externalIPs | list | `[]` | List of IP addresses at which the controller services are available |
| controller.service.internal.annotations | object | `{}` | Annotations are mandatory for the load balancer to come up. Varies with the cloud service. |
| controller.service.internal.enabled | bool | `false` | Enables an additional internal load balancer (besides the external one). |
-| controller.service.internal.loadBalancerSourceRanges | list | `[]` | |
+| controller.service.internal.loadBalancerSourceRanges | list | `[]` | Restrict access For LoadBalancer service. Defaults to 0.0.0.0/0. |
| controller.service.ipFamilies | list | `["IPv4"]` | List of IP families (e.g. IPv4, IPv6) assigned to the service. This field is usually assigned automatically based on cluster configuration and the ipFamilyPolicy field. |
-| controller.service.ipFamilyPolicy | string | `"SingleStack"` | |
+| controller.service.ipFamilyPolicy | string | `"SingleStack"` | Represents the dual-stack-ness requested or required by this Service. Possible values are SingleStack, PreferDualStack or RequireDualStack. The ipFamilies and clusterIPs fields depend on the value of this field. |
| controller.service.labels | object | `{}` | |
| controller.service.loadBalancerSourceRanges | list | `[]` | |
| controller.service.nodePorts.http | string | `""` | |
@@ -410,7 +410,7 @@ Kubernetes: `>=1.19.0-0`
| controller.tcp.configMapNamespace | string | `""` | Allows customization of the tcp-services-configmap; defaults to $(POD_NAMESPACE) |
| controller.terminationGracePeriodSeconds | int | `300` | `terminationGracePeriodSeconds` to avoid killing pods before we are ready |
| controller.tolerations | list | `[]` | Node tolerations for server scheduling to nodes with taints |
-| controller.topologySpreadConstraints | list | `[]` | |
+| controller.topologySpreadConstraints | list | `[]` | Topology spread constraints rely on node labels to identify the topology domain(s) that each Node is in. |
| controller.udp.annotations | object | `{}` | Annotations to be added to the udp config configmap |
| controller.udp.configMapNamespace | string | `""` | Allows customization of the udp-services-configmap; defaults to $(POD_NAMESPACE) |
| controller.updateStrategy | object | `{}` | The update strategy to apply to the Deployment or DaemonSet |
@@ -459,7 +459,7 @@ Kubernetes: `>=1.19.0-0`
| defaultBackend.replicaCount | int | `1` | |
| defaultBackend.resources | object | `{}` | |
| defaultBackend.service.annotations | object | `{}` | |
-| defaultBackend.service.externalIPs | list | `[]` | |
+| defaultBackend.service.externalIPs | list | `[]` | List of IP addresses at which the default backend service is available |
| defaultBackend.service.loadBalancerSourceRanges | list | `[]` | |
| defaultBackend.service.servicePort | int | `80` | |
| defaultBackend.service.type | string | `"ClusterIP"` | |
@@ -479,5 +479,3 @@ Kubernetes: `>=1.19.0-0`
| tcp | object | `{}` | TCP service key:value pairs |
| udp | object | `{}` | UDP service key:value pairs |
-----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.5.0](https://github.com/norwoodj/helm-docs/releases/v1.5.0)I will say it is possible that there are changes that maybe weren't synced last time. If that's the case, your PR might have to include those as well to bring them back in sync. If locally I commit those changes above, and re-run the commands, everything is fine: $ git add -u
$ git commit -m "docs(charts): updating"
$ git log -1
commit af4aae237c2fdadd88f1c874df67a9b749a6841b (HEAD -> 8123)
Author: Scott Crooks <scott.crooks@gmail.com>
Date: Tue Jan 11 07:38:12 2022 +0100
docs(charts): updating
$ ./helm-docs --chart-search-root=${PWD}/charts
$ git diff --exit-code > /dev/null
$ echo $?
0 |
|
Thanks @sc250024 . Root cause was the version of helm-docs being different on my laptop and the CI. I downloaded the latest release v1.5.0 of helm-docs to laptop. This implies that the README.md that is autogenerated by v1.5.0 the latest release of helm-docs and v1.6.0 as installed using |
k8s-ci-robot
added
the
do-not-merge/hold
k8s-ci-robot
added
the
lgtm
| @@ -167,14 +167,23 @@ Promoting the images basically means that images, that were pushed to staging co | |||
| - annotations | |||
| - artifacthub.io/prerelease: "true" | |||
| - artifacthub.io/changes: | | |||
| - Add the titles of the PRs merged after previous release | |||
| - Add the titles of the PRs merged after previous release here. I used the github-cli to get that list like so `gh pr list -s merged -L 38 -B main | cut -f1,2` | |||
There was a problem hiding this comment.
maybe remove the I used.. to be github-cli can be used to ....
k8s-ci-robot
removed
the
do-not-merge/hold
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: longwuyuan, rikatz, tao12345666333 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
Doing a follow up PR to change "I used ..." to "github-cli can be used ..."
Thanks,
; Long Wu Yuan
…On 1/12/22 9:52 PM, Carlos Tadeu Panato Junior wrote:
***@***.**** commented on this pull request.
lgtm just a comment in the docs
------------------------------------------------------------------------
In RELEASE.md
<#8125 (comment)>:
> @@ -167,14 +167,23 @@ Promoting the images basically means that images, that were pushed to staging co
- annotations
- artifacthub.io/prerelease: "true"
- artifacthub.io/changes: |
- - Add the titles of the PRs merged after previous release
+ - Add the titles of the PRs merged after previous release here. I used the github-cli to get that list like so `gh pr list -s merged -L 38 -B main | cut -f1,2`
maybe remove the |I used..| to be |github-cli can be used to ....|
—
Reply to this email directly, view it on GitHub
<#8125 (review)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ABGZVWQ4AN74PKT6DAOLL7TUVWTDNANCNFSM5LT2HSTQ>.
Triage notifications on the go with GitHub Mobile for iOS
<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675>
or Android
<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Multiple changes, using RELEASE.md, for release v1.1.1,
Even RELEASE.md edited to add the section on using
helm-docslocally and committing updated /charts/ingress-nginx/README.mdfixes: #8123