feat(doctool): Add support for doctool taking screenshots.#111
Open
spbsoluble wants to merge 9 commits intomainfrom
Open
feat(doctool): Add support for doctool taking screenshots.#111spbsoluble wants to merge 9 commits intomainfrom
spbsoluble wants to merge 9 commits intomainfrom
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.
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:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.