[BUG] Inconsistent README examples
Closed this issue · 0 comments
Vault server version
N/A
vault-action version
N/A
Describe the bug
The README has both secret/
and secret/data
with no explanations. It makes it un-intuitive to figure out what format the secrets
key uses without much troubleshooting. The data
part of this path is new and realtive to the secret type and doesn't not existing logically in the vault command line and is an artifact more of the api.
We should also document WHY this format exists such as expounding on how the kv2
is involved in this path. This makes this Action difficult to setup with things like HCP cloud if you already need to specify a namespace. A full HCP working example ( and perhaps Terraform code example using the terraform provider) in the disclosure triangle for the vault configuration is needed.
Small inconsistencies in a project like this already has many other moving pieces makes it hard to setup and troubleshoot. I'd also recommend a full Github Actions OIDC example which is not currently fully documented.