Skip to content

Commit bbc59ce

Browse files
spbsolublespbsoluble
committed
feat(doctool): Add support for doctool taking screenshots.
1 parent 9b30b5f commit bbc59ce

2 files changed

Lines changed: 97 additions & 29 deletions

File tree

‎.github/workflows/generate-readme.yml‎

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,34 @@ name: Generate README from templates and data files using doctool
22
on:
33
workflow_call:
44
secrets:
5-
token:
5+
token:
66
description: 'Secret token from caller workflow to approve readme'
77
required: true
8+
entra_username:
9+
description: 'Entra username for authentication'
10+
required: true
11+
entra_password:
12+
description: 'Entra password for authentication'
13+
required: false
14+
command_client_id:
15+
description: 'Command client ID for API authentication'
16+
required: false
17+
command_client_secret:
18+
description: 'Command client secret for API authentication'
19+
required: false
20+
inputs:
21+
command_token_url:
22+
type: string
23+
description: 'URL for obtaining command tokens'
24+
required: false
25+
command_hostname:
26+
type: string
27+
description: 'Command hostname for API endpoints'
28+
required: false
29+
command_base_api_path:
30+
type: string
31+
description: 'Base API path for the Command API'
32+
required: false
833
permissions:
934
contents: write
1035

@@ -20,8 +45,17 @@ jobs:
2045
path: doctool
2146
token: ${{ secrets.token }}
2247

23-
- name: Launch local doctool
48+
- name: Launch local doctool
2449
uses: ./doctool
2550
id: launch-doctool
2651
with:
2752
token: ${{ secrets.token }}
53+
entra_username: ${{ secrets.ENTRA_USERNAME }}
54+
entra_password: ${{ secrets.ENTRA_PASSWORD }}
55+
command_client_id: ${{ secrets.COMMAND_CLIENT_ID }}
56+
command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }}
57+
command_token_url: ${{ inputs.command_token_url }}
58+
command_hostname: ${{ inputs.command_hostname }}
59+
command_base_api_path: ${{ inputs.command_base_api_path }}
60+
61+

‎.github/workflows/starter.yml‎

Lines changed: 61 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ on:
55
token:
66
description: 'GitHub token'
77
required: true
8-
## This secret 'APPROVE_README_PUSH' is not used.
9-
## Remove when the v3 bootstrap has been updated
8+
## This secret 'APPROVE_README_PUSH' is not used.
9+
## Remove when the v3 bootstrap has been updated
1010
APPROVE_README_PUSH:
1111
description: 'Token to add-and-commit generated readme'
12-
required: true
12+
required: true
1313
gpg_key:
1414
description: 'GPG Private Key'
1515
required: true
@@ -25,6 +25,32 @@ on:
2525
scan_token:
2626
description: 'Polaris token'
2727
required: false
28+
entra_username:
29+
description: 'Entra username for authentication'
30+
required: true
31+
entra_password:
32+
description: 'Entra password for authentication'
33+
required: false
34+
command_client_id:
35+
description: 'Command client ID for API authentication'
36+
required: false
37+
command_client_secret:
38+
description: 'Command client secret for API authentication'
39+
required: false
40+
inputs:
41+
command_token_url:
42+
type: string
43+
description: 'URL for obtaining command tokens'
44+
required: false
45+
command_hostname:
46+
type: string
47+
description: 'Command hostname for API endpoints'
48+
required: false
49+
command_base_api_path:
50+
type: string
51+
description: 'Base API path for the Command API'
52+
required: false
53+
2854

2955

3056
jobs:
@@ -78,74 +104,82 @@ jobs:
78104
token: ${{ secrets.GITHUB_TOKEN }}
79105
- name: Create an array from platform_list input #
80106
id: vars
81-
run:
107+
run:
82108
echo "platform_matrix=`cat integration-manifest.json | jq '.platform_matrix'`" | tee -a $GITHUB_OUTPUT | tee -a $GITHUB_STEP_SUMMARY
83109

84110
call-create-github-release-workflow:
85111
uses: Keyfactor/actions/.github/workflows/github-release.yml@v3
86112

87113
call-dotnet-build-and-release-workflow:
88-
needs: [call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow]
114+
needs: [ call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow ]
89115
if: needs.call-get-primary-language.outputs.primary_language == 'C#'
90116
uses: keyfactor/actions/.github/workflows/dotnet-build-and-release.yml@v3
91117
with:
92118
release_version: ${{ needs.call-create-github-release-workflow.outputs.release_version }}
93119
release_url: ${{ needs.call-create-github-release-workflow.outputs.release_url }}
94120
release_dir: ${{ needs.call-assign-from-json-workflow.outputs.release_dir }}
95-
integration_type: ${{ needs.call-assign-from-json-workflow.outputs.integration_type }}
96-
secrets:
121+
integration_type: ${{ needs.call-assign-from-json-workflow.outputs.integration_type }}
122+
secrets:
97123
token: ${{ secrets.token }}
98124

99125
call-go-build-and-release-workflow:
100-
needs: [call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow,call-goreleaser-exists]
101-
if: needs.call-get-primary-language.outputs.primary_language == 'Go' && needs.call-goreleaser-exists.outputs.goreleaser-exists == 'true'
126+
needs: [ call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow,call-goreleaser-exists ]
127+
if: needs.call-get-primary-language.outputs.primary_language == 'Go' && needs.call-goreleaser-exists.outputs.goreleaser-exists == 'true'
102128
uses: keyfactor/actions/.github/workflows/go-build-and-release.yml@v3
103-
with:
129+
with:
104130
release_version: ${{ needs.call-create-github-release-workflow.outputs.release_version }}
105-
secrets:
131+
secrets:
106132
token: ${{ secrets.GITHUB_TOKEN }}
107133
gpg_key: ${{ secrets.gpg_key }}
108134
gpg_pass: ${{ secrets.gpg_pass }}
109135

110136
call-container-build-and-release-workflow:
111-
needs: [call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow,call-goreleaser-exists,setup_platforms]
137+
needs: [ call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow,call-goreleaser-exists,setup_platforms ]
112138
if: needs.call-get-primary-language.outputs.primary_language == 'Go' && needs.call-goreleaser-exists.outputs.goreleaser-exists == 'false'
113139
uses: keyfactor/actions/.github/workflows/container-build-and-release.yml@v3
114-
with:
140+
with:
115141
release_version: ${{ needs.call-create-github-release-workflow.outputs.release_version }}
116142
platform_list: ${{ fromJson(needs.setup_platforms.outputs.platform_matrix) }}
117-
secrets:
143+
secrets:
118144
docker-user: ${{ secrets.docker-user }}
119145
docker-token: ${{ secrets.docker-token }}
120146

121147
call-maven-build-and-release-workflow:
122-
needs: [call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow]
148+
needs: [ call-get-primary-language, call-assign-from-json-workflow, call-create-github-release-workflow ]
123149
if: needs.call-get-primary-language.outputs.primary_language == 'Java'
124150
uses: keyfactor/actions/.github/workflows/maven-build-and-release.yml@v3
125151
with:
126152
release_version: ${{ needs.call-create-github-release-workflow.outputs.release_version }}
127153
release_url: ${{ needs.call-create-github-release-workflow.outputs.release_url }}
128154
release_dir: ${{ needs.call-assign-from-json-workflow.outputs.release_dir }}
129-
secrets:
155+
secrets:
130156
token: ${{ secrets.token }}
131157

132158
call-generate-readme-workflow:
133159
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
134-
uses: Keyfactor/actions/.github/workflows/generate-readme.yml@v3
160+
uses: Keyfactor/actions/.github/workflows/generate-readme.yml@screenshots
161+
with:
162+
command_token_url: ${{ inputs.command_token_url }}
163+
command_hostname: ${{ inputs.command_hostname }}
164+
command_base_api_path: ${{ inputs.command_base_api_path }}
135165
secrets:
136166
token: ${{ secrets.token }}
167+
entra_username: ${{ secrets.ENTRA_USERNAME }}
168+
entra_password: ${{ secrets.ENTRA_PASSWORD }}
169+
command_client_id: ${{ secrets.COMMAND_CLIENT_ID }}
170+
command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }}
137171

138172
call-update-catalog-workflow:
139173
needs: call-assign-from-json-workflow
140174
if: needs.call-assign-from-json-workflow.outputs.update_catalog == 'true' && github.ref_name == 'main' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch')
141175
uses: Keyfactor/actions/.github/workflows/update-catalog.yml@v3
142-
secrets:
176+
secrets:
143177
token: ${{ secrets.token }}
144178

145179
call-repository-configuration-workflow:
146180
if: github.event_name == 'create' && startsWith(github.ref, 'refs/heads/release-')
147181
uses: Keyfactor/actions/.github/workflows/kf-configure-repo.yml@v3
148-
secrets:
182+
secrets:
149183
token: ${{ secrets.token }}
150184

151185
call-polaris-scan-workflow:
@@ -157,11 +191,11 @@ jobs:
157191
token: ${{ secrets.scan_token }}
158192

159193
call-post-release-workflow:
160-
needs: [call-assign-from-json-workflow, call-create-github-release-workflow]
161-
if: needs.call-create-github-release-workflow.outputs.IS_FULL_RELEASE == 'True'
162-
uses: Keyfactor/actions/.github/workflows/kf-post-release.yml@v3
163-
secrets:
164-
token: ${{ secrets.token }}
165-
with:
166-
branchname: ${{ github.event.pull_request.base.ref }}
167-
release_version: ${{ needs.call-create-github-release-workflow.outputs.release_version }}
194+
needs: [ call-assign-from-json-workflow, call-create-github-release-workflow ]
195+
if: needs.call-create-github-release-workflow.outputs.IS_FULL_RELEASE == 'True'
196+
uses: Keyfactor/actions/.github/workflows/kf-post-release.yml@v3
197+
secrets:
198+
token: ${{ secrets.token }}
199+
with:
200+
branchname: ${{ github.event.pull_request.base.ref }}
201+
release_version: ${{ needs.call-create-github-release-workflow.outputs.release_version }}

0 commit comments

Comments
 (0)