From 972b530085b1a448ba805ca93a4904bf93ec1a15 Mon Sep 17 00:00:00 2001 From: spbsoluble <1661003+spbsoluble@users.noreply.github.com> Date: Wed, 25 Mar 2026 13:53:27 -0700 Subject: [PATCH 1/3] 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. --- .github/workflows/generate-readme.yml | 86 +++++++++------------------ .github/workflows/starter.yml | 10 +--- 2 files changed, 28 insertions(+), 68 deletions(-) diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml index 53f6b96..406849f 100644 --- a/.github/workflows/generate-readme.yml +++ b/.github/workflows/generate-readme.yml @@ -1,59 +1,27 @@ -name: Generate README from templates and data files using doctool -on: - workflow_call: - secrets: - token: - description: 'Secret token from caller workflow to approve readme' - required: true - entra_username: - description: 'Entra username for authentication' - required: false - entra_password: - description: 'Entra password for authentication' - required: false - command_client_id: - description: 'Command client ID for API authentication' - required: false - command_client_secret: - description: 'Command client secret for API authentication' - required: false - inputs: - command_token_url: - type: string - description: 'URL for obtaining command tokens' - required: false - command_hostname: - type: string - description: 'Command hostname for API endpoints' - required: false - command_base_api_path: - type: string - description: 'Base API path for the Command API' - required: false -permissions: - contents: write - -jobs: - update-docs: - runs-on: ubuntu-latest - name: Use private doctool action in public repository - steps: - - name: checkout-action - uses: keyfactor/checkout@v4 - with: - repository: keyfactor/doctool - path: doctool - token: ${{ secrets.token }} - - - name: Launch local doctool - uses: ./doctool - id: launch-doctool - with: - token: ${{ secrets.token }} - entra_username: ${{ secrets.entra_username }} - entra_password: ${{ secrets.entra_password }} - command_client_id: ${{ secrets.command_client_id }} - command_client_secret: ${{ secrets.command_client_secret }} - command_token_url: ${{ vars.DOCTOOL_COMMAND_TOKEN_URL }} - command_hostname: ${{ vars.DOCTOOL_COMMAND_HOSTNAME }} - command_base_api_path: ${{ vars.DOCTOOL_COMMAND_BASE_API_PATH }} +name: Generate README from templates and data files using doctool +on: + workflow_call: + secrets: + token: + description: 'Secret token from caller workflow to approve readme' + required: true +permissions: + contents: write + +jobs: + update-docs: + runs-on: ubuntu-latest + name: Use private doctool action in public repository + steps: + - name: checkout-action + uses: actions/checkout@v4 + with: + repository: keyfactor/doctooldotnet + path: doctooldotnet + token: ${{ secrets.token }} + + - name: Launch local doctool + uses: ./doctooldotnet + id: launch-doctool + with: + token: ${{ secrets.token }} \ No newline at end of file diff --git a/.github/workflows/starter.yml b/.github/workflows/starter.yml index 2be1643..ddd7f61 100644 --- a/.github/workflows/starter.yml +++ b/.github/workflows/starter.yml @@ -131,17 +131,9 @@ jobs: permissions: contents: write # Explicitly grant write permission if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' - uses: Keyfactor/actions/.github/workflows/generate-readme.yml@v4 - with: - command_token_url: ${{ vars.COMMAND_TOKEN_URL }} - command_hostname: ${{ vars.COMMAND_HOSTNAME }} - command_base_api_path: ${{ vars.COMMAND_API_PATH }} + uses: Keyfactor/actions/.github/workflows/generate-readme.yml@feature/dotnet-doctool secrets: token: ${{ secrets.token }} - entra_username: ${{ secrets.ENTRA_USERNAME }} - entra_password: ${{ secrets.ENTRA_PASSWORD }} - command_client_id: ${{ secrets.COMMAND_CLIENT_ID }} - command_client_secret: ${{ secrets.COMMAND_CLIENT_SECRET }} call-update-catalog-workflow: needs: call-assign-from-json-workflow From 64f4bbebe9c7bfc2af4f73091934b09eed2ad9be Mon Sep 17 00:00:00 2001 From: spbsoluble <1661003+spbsoluble@users.noreply.github.com> Date: Wed, 25 Mar 2026 13:59:32 -0700 Subject: [PATCH 2/3] fix: checkout feature/logging-and-docs ref for testing --- .github/workflows/generate-readme.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml index 406849f..2d1c983 100644 --- a/.github/workflows/generate-readme.yml +++ b/.github/workflows/generate-readme.yml @@ -17,6 +17,7 @@ jobs: uses: actions/checkout@v4 with: repository: keyfactor/doctooldotnet + ref: feature/logging-and-docs path: doctooldotnet token: ${{ secrets.token }} From a8a42b97022418d71fb5577d0b11f59056e8d2c7 Mon Sep 17 00:00:00 2001 From: spbsoluble <1661003+spbsoluble@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:22:28 -0700 Subject: [PATCH 3/3] fix: checkout integration repo and doctool before running action --- .github/workflows/generate-readme.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/generate-readme.yml b/.github/workflows/generate-readme.yml index 2d1c983..41661fe 100644 --- a/.github/workflows/generate-readme.yml +++ b/.github/workflows/generate-readme.yml @@ -13,13 +13,19 @@ jobs: runs-on: ubuntu-latest name: Use private doctool action in public repository steps: - - name: checkout-action + - name: Checkout integration repository + uses: actions/checkout@v4 + with: + token: ${{ secrets.token }} + + - name: Checkout doctool action uses: actions/checkout@v4 with: repository: keyfactor/doctooldotnet ref: feature/logging-and-docs path: doctooldotnet token: ${{ secrets.token }} + clean: false - name: Launch local doctool uses: ./doctooldotnet