From f41e5aefc669a0539caf3b3bd6413240310f48e5 Mon Sep 17 00:00:00 2001
From: Brian Scholer <1260690+briantist@users.noreply.github.com>
Date: Mon, 17 Jan 2022 13:52:17 -0500
Subject: [PATCH] show defined secrets in workflow docs

---
 .../internal/gha_docs/roles/generate/tasks/main.yml      | 1 +
 .../gha_docs/roles/generate/templates/workflow.md.j2     | 9 +++++++++
 2 files changed, 10 insertions(+)

diff --git a/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/tasks/main.yml b/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/tasks/main.yml
index 23f3f2d..507f2c7 100644
--- a/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/tasks/main.yml
+++ b/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/tasks/main.yml
@@ -17,6 +17,7 @@
     reference: '{{ file | basename }}'
     jobs: '{{ _src.jobs }}'
     inputs: '{{ _src[true].workflow_call.inputs | default({}) }}'
+    secrets: '{{ _src[true].workflow_call.secrets | default({}) }}'
     outputs: '{{ _src[true].workflow_call.outputs | default({}) }}'
   ansible.builtin.template:
     src: workflow.md.j2
diff --git a/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/templates/workflow.md.j2 b/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/templates/workflow.md.j2
index f715e37..d83715d 100644
--- a/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/templates/workflow.md.j2
+++ b/.internal/ansible/ansible_collections/internal/gha_docs/roles/generate/templates/workflow.md.j2
@@ -19,6 +19,15 @@
 
 <hr />
 
+### Secrets
+| Name (✅required) | Description |
+| ----------------- | ----------- |
+{% for name, sec in secrets.items() %}
+| `{{ name }}`{% if sec.required %}✅{% endif %} | {{ (sec.description.replace("\n", '<br />')) }} |
+{% endfor %}
+
+<hr />
+
 ### Outputs
 | Name | Description |
 | ---- | ----------- |