Skip to content

Commit 972b530

Browse files
committed
feat: replace keyfactor/doctool with .NET doctooldotnet action
Replaces the private keyfactor/doctool GitHub Action with the .NET-based keyfactor/doctooldotnet action. The new tool reads all data from integration-manifest.json, so Keyfactor Command API credentials are no longer needed and have been removed from both generate-readme.yml and starter.yml.
1 parent f98db1f commit 972b530

2 files changed

Lines changed: 28 additions & 68 deletions

File tree

Lines changed: 27 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,27 @@
1-
name: Generate README from templates and data files using doctool
2-
on:
3-
workflow_call:
4-
secrets:
5-
token:
6-
description: 'Secret token from caller workflow to approve readme'
7-
required: true
8-
entra_username:
9-
description: 'Entra username for authentication'
10-
required: false
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
33-
permissions:
34-
contents: write
35-
36-
jobs:
37-
update-docs:
38-
runs-on: ubuntu-latest
39-
name: Use private doctool action in public repository
40-
steps:
41-
- name: checkout-action
42-
uses: keyfactor/checkout@v4
43-
with:
44-
repository: keyfactor/doctool
45-
path: doctool
46-
token: ${{ secrets.token }}
47-
48-
- name: Launch local doctool
49-
uses: ./doctool
50-
id: launch-doctool
51-
with:
52-
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: ${{ vars.DOCTOOL_COMMAND_TOKEN_URL }}
58-
command_hostname: ${{ vars.DOCTOOL_COMMAND_HOSTNAME }}
59-
command_base_api_path: ${{ vars.DOCTOOL_COMMAND_BASE_API_PATH }}
1+
name: Generate README from templates and data files using doctool
2+
on:
3+
workflow_call:
4+
secrets:
5+
token:
6+
description: 'Secret token from caller workflow to approve readme'
7+
required: true
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
update-docs:
13+
runs-on: ubuntu-latest
14+
name: Use private doctool action in public repository
15+
steps:
16+
- name: checkout-action
17+
uses: actions/checkout@v4
18+
with:
19+
repository: keyfactor/doctooldotnet
20+
path: doctooldotnet
21+
token: ${{ secrets.token }}
22+
23+
- name: Launch local doctool
24+
uses: ./doctooldotnet
25+
id: launch-doctool
26+
with:
27+
token: ${{ secrets.token }}

.github/workflows/starter.yml

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -131,17 +131,9 @@ jobs:
131131
permissions:
132132
contents: write # Explicitly grant write permission
133133
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
134-
uses: Keyfactor/actions/.github/workflows/generate-readme.yml@v4
135-
with:
136-
command_token_url: ${{ vars.COMMAND_TOKEN_URL }}
137-
command_hostname: ${{ vars.COMMAND_HOSTNAME }}
138-
command_base_api_path: ${{ vars.COMMAND_API_PATH }}
134+
uses: Keyfactor/actions/.github/workflows/generate-readme.yml@feature/dotnet-doctool
139135
secrets:
140136
token: ${{ secrets.token }}
141-
entra_username: ${{ secrets.ENTRA_USERNAME }}
142-
entra_password: ${{ secrets.ENTRA_PASSWORD }}
143-
command_client_id: ${{ secrets.COMMAND_CLIENT_ID }}
144-
command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }}
145137

146138
call-update-catalog-workflow:
147139
needs: call-assign-from-json-workflow

0 commit comments

Comments
 (0)