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

v1.10 ignores double "##" #148

Open
mkilchhofer opened this issue May 18, 2022 · 3 comments · May be fixed by #254
Open

v1.10 ignores double "##" #148

mkilchhofer opened this issue May 18, 2022 · 3 comments · May be fixed by #254
Labels
bug Something isn't working enhancement New feature or request
Milestone
General Cleanup

Comments

@mkilchhofer
Copy link

Hi @norwoodj

It seems that v1.10.0 introduces a kind of different behavior.
In the past we used something like this:

  # -- Define user-defined context
  ## For more information: https://argocd-notifications.readthedocs.io/en/stable/templates/#defining-user-defined-context
  context: {}
    # region: east
    # environmentName: staging

the new version now introduces this change:

-| notifications.context | object | `{}` | Define user-defined context |
+| notifications.context | object | `{}` | Define user-defined context # For more information: https://argocd-notifications.readthedocs.io/en/stable/templates/#defining-user-defined-context |

So in the past lines with two ## were ignored in the rendered README. Is this an intended change?
@mkilchhofer mkilchhofer mentioned this issue May 18, 2022
Merged
3 tasks
@hairmare hairmare mentioned this issue May 31, 2022
Merged
6 tasks
@mszostok
Copy link

mszostok commented Jul 12, 2022 •
edited
Loading

The option to ignore the comments is quite useful. Our use-case is to have more info about the format:

  # Using existing Communication secret. It MUST be in the `botkube` Namespace.
  ## Secret format:
  ##  stringData:
  ##    comm_config.yaml: |
  ##      communications:
  ##        # Here specify settings for each app, like Slack, Mattermost etc.
  ##        # NOTE: Use setting format visible below.
  existingSecretName: ""

I hope that it will be added back 🤞

@pdrastil pdrastil mentioned this issue Feb 18, 2023
Closed
@Nepo26 Nepo26 added bug Something isn't working enhancement New feature or request labels Jun 29, 2023
@Nepo26 Nepo26 changed the title [Bug?] v1.10 ignores double "##" v1.10 ignores double "##" Jun 29, 2023
@Nepo26 Nepo26 mentioned this issue Jun 29, 2023
Open
@Nepo26 Nepo26 added this to the General Cleanup milestone Jul 25, 2023
@acolombier
Copy link

Any update on this? Are you accepting PR to restore that behaviour?

@norwoodj
Copy link
Owner

norwoodj commented Jul 7, 2024 •
edited
Loading

Hey, indeed, Sorry about breaking this behavior, I see the utility of this feature. I would certainly accept a PR to change this back to the old behavior. I just don't have time to do it myself.

@acolombier acolombier linked a pull request Jul 8, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working enhancement New feature or request
Projects
Helm Docs Improvement
Status: No status
Milestone
General Cleanup
Development

Successfully merging a pull request may close this issue.

fix: restore support for ignored yaml comment acolombier/helm-docs
5 participants
@norwoodj @acolombier @mkilchhofer @mszostok @Nepo26