-
Notifications
You must be signed in to change notification settings - Fork 4
feat(doctool): Add support for doctool taking screenshots. #111
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
8996b6b to
bbc59ce
Compare
…refs rather than inputs.
…refs rather than inputs.
…refs rather than inputs.
…refs rather than inputs.
…refs rather than inputs.
# Conflicts: # .github/workflows/starter.yml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds support for passing authentication and Command API parameters through to the doctool for screenshot generation and updates workflows accordingly.
- Introduce new Entra and Command API credentials as workflow inputs/secrets
- Update the reusable
generate-readmecall to thescreenshotsbranch and forward new parameters - Re-enable the Polaris scan job that was previously commented out
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/workflows/starter.yml | Added Entra and Command API credential inputs/secrets; updated generate-readme call to @screenshots; un-commented Polaris scan job |
| .github/workflows/generate-readme.yml | Added credential secrets and inputs to workflow_call; wired them into the launch-doctool step |
Comments suppressed due to low confidence (5)
.github/workflows/generate-readme.yml:57
- This step references repository variables instead of the workflow input. It should use
${{ inputs.command_token_url }}to pass through thecommand_token_urlinput.
command_token_url: ${{ vars.DOCTOOL_COMMAND_TOKEN_URL }}
.github/workflows/generate-readme.yml:58
- This step references
vars.DOCTOOL_COMMAND_HOSTNAMEinstead of the declared input. It should use${{ inputs.command_hostname }}.
command_hostname: ${{ vars.DOCTOOL_COMMAND_HOSTNAME }}
.github/workflows/generate-readme.yml:59
- This step references
vars.DOCTOOL_COMMAND_BASE_API_PATHinstead of the input. It should use${{ inputs.command_base_api_path }}.
command_base_api_path: ${{ vars.DOCTOOL_COMMAND_BASE_API_PATH }}
.github/workflows/starter.yml:161
- [nitpick] Pinning to a floating branch/tag like
screenshotscan lead to unpredictable builds. Consider using a semver tag or commit SHA for reproducibility.
uses: Keyfactor/actions/.github/workflows/generate-readme.yml@screenshots
.github/workflows/generate-readme.yml:8
- [nitpick] The same Entra and Command API credential definitions are duplicated across workflows. Consider centralizing them in a shared reusable workflow or using YAML anchors to reduce duplication.
entra_username:
No description provided.