Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR upgrades the GitHub Actions workflows from version 3 to version 4, introducing improved documentation generation capabilities and modernizing the workflow structure.
Key Changes:
- Upgrade all workflow references from v3 to v4
- Add new authentication parameters for Entra and Command API integration
- Introduce doctool functionality for automated screenshot generation in Universal Orchestrator extensions
- Remove legacy v3-specific templates and shared data files
Reviewed Changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| readme-templates/readme_shared_data.json | Removes legacy shared template data for v3 system |
| readme-templates/readme_platform_pam.md | Removes v3 PAM provider template |
| readme-templates/readme_platform_orchestrator.md | Removes v3 orchestrator platform template |
| readme-templates/readme_platform_cagateway.md | Removes v3 CA gateway platform template |
| readme-templates/readme.md.tpl | Removes v3 main README template |
| README.md | Updates documentation from v3 to v4 with new features and usage examples |
| .github/workflows/starter.yml | Updates to v4 workflows and adds new authentication parameters |
| .github/workflows/starter-v3.yml | Creates new v3 compatibility workflow file |
| .github/workflows/github-release.yml | Updates workflow reference to v4 |
| .github/workflows/generate-readme.yml | Adds new authentication parameters for doctool integration |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
irby
left a comment
irby
left a comment
There was a problem hiding this comment.
Everything looks good to me. Do want to check and make sure the case sensitivity and vars vs input isn't an issue.
| 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 }} |
There was a problem hiding this comment.
Just want to make sure, but this doesn't need to be inputs.command_token_url, etc., does it?
There was a problem hiding this comment.
I think I initially had used inputs. for all these params before and things weren't working, but the workflow is working as-is so I think this is fine
| command_base_api_path: ${{ vars.COMMAND_API_PATH }} | ||
| secrets: | ||
| token: ${{ secrets.token }} | ||
| entra_username: ${{ secrets.ENTRA_USERNAME }} |
There was a problem hiding this comment.
Want to make sure Actions is not case sensitive, this doesn't need to be {{ secrets.entra_username }}?
There was a problem hiding this comment.
The org secret name is all caps ENTRA_USERNAME I suspect I'm probably not using the inputs properly(/at all) but when I was using inputs. the value was empty.
| uses: Keyfactor/actions/.github/workflows/generate-readme.yml@v3 | ||
| uses: Keyfactor/actions/.github/workflows/generate-readme.yml@v4 | ||
| with: | ||
| command_token_url: ${{ vars.COMMAND_TOKEN_URL }} |
There was a problem hiding this comment.
Shouldn't this be ${{ inputs.command_token_url }}? I think this is also case sensitive.
|
🎉 This PR is included in version 3.4.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 3.4.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
3 participants
Features
doctoolscreenshots via static SES environment