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.

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

Pipe | breaks table output of values.yml #171

Open
BWibo opened this issue Feb 3, 2023 · 0 comments
Open

Pipe | breaks table output of values.yml #171

BWibo opened this issue Feb 3, 2023 · 0 comments
Labels
bug Something isn't working

Comments

@BWibo
Copy link

BWibo commented Feb 3, 2023

Hey there,

this is similar to #118.

I have following in a values.yml:

readinessProbe:
  # -- Enable/disable readiness probe
  # [Readiness probe](https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#container-probes)
  # See the [API reference](https://kubernetes.io/docs/reference/kubernetes-api/workload-resources/pod-v1/#Probe) for details.
  # Use `readinessProbe.probe: {}` to configure
  # [readinessProbe probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/)
  enabled: true
  initialDelaySeconds: 10
  periodSeconds: 5
  timeoutSeconds: 1
  successThreshold: 1
  failureThreshold: 5
  terminationGracePeriodSeconds:
  probe:
    exec:
      command: [ bash, -c, 'wget -S "http://127.0.0.1:3000/api/health" |& grep "200 OK"' ] 

Apparently, the pipe in the command is interpreted as a column separator in the generated markdown:

| readinessProbe.probe.exec.command[2] | string | `"wget -S \"http://127.0.0.1:3000/api/health\" |& grep \"200 OK\""` |  |

Rendered result:
grafik

Escaping the pipe manually seems to help:

| readinessProbe.probe.exec.command[2] | string | `"wget -S \"http://127.0.0.1:3000/api/health\" \|& grep \"200 OK\""` |  |

grafik

Version info:

$ docker run --rm --volume "$PWD/helm/charts:/helm-docs" -u $(id -u) jnorwood/helm-docs:latest --version
helm-docs version 1.11.0
@Nepo26 Nepo26 added the bug Something isn't working label Jun 29, 2023
@Nepo26 Nepo26 added this to the General Cleanup milestone Jul 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: No status
Development

No branches or pull requests

2 participants