grafana icon indicating copy to clipboard operation
grafana copied to clipboard

config_ldap_group_mapping VS. config_ldap_group_mappings since 10.0.0

Open jblaine opened this issue 2 years ago • 0 comments

:speaking_head: Foreword

Thank for taking the time to fill this bug report fully. Without it we may not be able to fix the bug, and the issue may be closed without resolution.

:ghost: Brief Description

Since 10.0.0 there is a raging plural vs. singular battle going on in the land of config_ldap_group_mapping / config_ldap_group_mappings and there is no CHANGELOG.md info about whatever is going on.

:pancakes: Cookbook version

10.0.0 onward

:woman_cook: Chef-Infra Version

N/A

:tophat: Platform details

N/A

Steps To Reproduce

There is no mention in CHANGELOG.md of any plural<->singular change of name for this resource. It's not clear if there should be any mention or if, instead, there is just a massive mix-up going on lately. This happened between 9.x --> 10.x.

  • As of cookbook version 9.7.1 and earlier, the resource and its source file_ name were plural (grafana_config_ldap_group_mappings and resources/config_ldap_group_mappings.rb respectively).
  • Currently, the resource file is named singularly: resources/config_ldap_group_mapping.rb.
  • Currently, the documentation link in README.md is singular and gives a 404 error: https://github.com/sous-chefs/grafana/blob/main/README.md with link there to https://github.com/sous-chefs/grafana/tree/main/documentation/grafana_config_ldap_group_mapping.md (404)
  • Currently, the documentation file for the resource is plural documentation/grafana_config_ldap_group_mappings.md
  • Note that if someone is renaming this resource to be singular, it has historically been plural because that is what the actual Grafana stanza is - plural: https://grafana.com/docs/grafana/latest/auth/ldap/#group-mappings

:police_car: Expected behavior

Consistent naming and a CHANGELOG.md having appropriate information if something is changing in name. Is it?

:heavy_plus_sign: Additional context

N/A

jblaine avatar Jun 02 '22 17:06 jblaine