V4 #128
V4 #128
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR prepares the Actions repository for the v4 release by updating documentation, reformatting the README for better readability, and temporarily disabling the Polaris security scan workflow.
- Reformatted and expanded README.md with improved line wrapping, consistent indentation, and a new comprehensive inputs table
- Removed CHANGELOG entry for version 3.4.0 in preparation for v4
- Commented out the Polaris scan workflow call while adding
continue-on-error: trueto the scan job definition
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| README.md | Reformatted documentation with improved line wrapping, added comprehensive inputs table for workflow parameters, and updated code examples with consistent formatting |
| CHANGELOG.md | Removed version 3.4.0 entry (dated 2025-09-11) as part of v4 transition |
| .github/workflows/starter.yml | Commented out the Polaris scan workflow call (lines 159-165) |
| .github/workflows/kf-polaris-scan.yml | Added continue-on-error: true to allow workflow to continue if scan fails |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | gpg_key | Secret | GPG private key for signing golang builds | Optional (golang builds) | | ||
| | gpg_pass | Secret | GPG passphrase for signing golang builds | Optional (golang builds) | |
There was a problem hiding this comment.
The documentation indicates gpg_key and gpg_pass are "Optional (golang builds)", but in the workflow definition (.github/workflows/starter.yml lines 10 and 13), both are marked as required: true. If these parameters are truly required by the workflow schema, the documentation should reflect this, even if they're only utilized for golang builds. Consider either updating the workflow to make them optional, or correcting the documentation to indicate they are required.
|
|
||
| * Configure repository settings - This will use the properties from the json to update topic and description, and will | ||
| set the teams permissions on the repo accordingly. If the ref created is a branch that matches "release-\*.\*", branch | ||
| protection is added, autlink reference set ab# to devops [***kf-configure-repo***] |
There was a problem hiding this comment.
Typo: "autlink" should be "autolink".
| protection is added, autlink reference set ab# to devops [***kf-configure-repo***] | |
| protection is added, autolink reference set ab# to devops [***kf-configure-repo***] |
| uploaded | ||
| * If the pr is determined to be `merged` and `closed`, a final "official" release is built and published to GitHub | ||
| releases, and if `"update_catalog": true` is set in the json manifest, a catalog entry will be created/updated | ||
| * Polaris SAST/SCAN scans run when push to `release-*` or main occurs |
There was a problem hiding this comment.
The documentation states "Polaris SAST/SCAN scans run when push to release-* or main occurs", but the Polaris scan workflow is currently commented out in .github/workflows/starter.yml (lines 159-165). This documentation should either be removed or updated to reflect that the Polaris scan is currently disabled.
| * Polaris SAST/SCAN scans run when push to `release-*` or main occurs |
| } | ||
| ``` | ||
|
|
||
| #### Example workflow `keyfactor-bootsrap-workflow.yml` |
There was a problem hiding this comment.
Typo in filename: "bootsrap" should be "bootstrap".
| #### Example workflow `keyfactor-bootsrap-workflow.yml` | |
| #### Example workflow `keyfactor-bootstrap-workflow.yml` |
| | token | Secret | Build token for workflow execution | Required | | ||
| | gpg_key | Secret | GPG private key for signing golang builds | Optional (golang builds) | | ||
| | gpg_pass | Secret | GPG passphrase for signing golang builds | Optional (golang builds) | | ||
| | scan_token | Secret | Token for SAST/Polaris scan | Required | |
There was a problem hiding this comment.
The scan_token parameter is marked as "Required" in the documentation, but in the actual workflow definition (.github/workflows/starter.yml line 22), it's marked as required: false, and the Polaris scan workflow is currently commented out (lines 159-165). The documentation should reflect the actual requirement status as "Optional" or note that it's currently unused.
| | scan_token | Secret | Token for SAST/Polaris scan | Required | | |
| | scan_token | Secret | Token for SAST/Polaris scan | Optional (currently unused) | |
| * | ||
| * C#: run the [dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) workflow | ||
| * | ||
| * Go builds: run the go-build-and-release.yml workflow (still in progress) | ||
| * All languages: | ||
| * | ||
| * Generate/Update `README.md` using `doctool` [generate-readme.yml](.github/workflows/generate-readme.yml) | ||
| * |
There was a problem hiding this comment.
The list structure contains empty bullet points (lines 158, 160, 163, 165) which are unconventional and may not render correctly in markdown. Consider restructuring this section to use proper nested lists without empty parent bullets, or use a different formatting approach such as indented bullets without the empty parent items.
| * | |
| * C#: run the [dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) workflow | |
| * | |
| * Go builds: run the go-build-and-release.yml workflow (still in progress) | |
| * All languages: | |
| * | |
| * Generate/Update `README.md` using `doctool` [generate-readme.yml](.github/workflows/generate-readme.yml) | |
| * | |
| * For C#: | |
| * Run the [dotnet-build-and-release.yml](.github/workflows/dotnet-build-and-release.yml) workflow | |
| * For Go: | |
| * Run the go-build-and-release.yml workflow (still in progress) | |
| * For all languages: | |
| * Generate/Update `README.md` using `doctool` [generate-readme.yml](.github/workflows/generate-readme.yml) |
|
🎉 This PR is included in version 3.4.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
No description provided.