docs: update tool version issue template#1096
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request refactors the tool version evaluation issue creation workflow by extracting the issue template from inline YAML to a dedicated markdown file, improving maintainability and clarity.
Changes:
- Introduced a new markdown template file (
.github/TOOL_VERSION_ISSUE_TEMPLATE.md) containing the complete issue checklist and instructions - Updated the workflow (
.github/workflows/issue-creation-tool-versions.yml) to reference the external template file instead of an inline body - Enhanced workflow robustness with improved sparse checkout, better error handling for issue closing/unpinning, and clearer permissions documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
.github/workflows/issue-creation-tool-versions.yml |
Refactored to use external template file, added sparse checkout, improved issue closing logic, and documented permissions |
.github/TOOL_VERSION_ISSUE_TEMPLATE.md |
New template file with restructured checklist format using tables, emoji headers, and improved documentation |
Contributor
✅
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| ✅ ACTION | actionlint | 20 | 0 | 0 | 0.53s | |
| ✅ DOCKERFILE | hadolint | 3 | 0 | 0 | 0.65s | |
| ✅ GHERKIN | gherkin-lint | 6 | 0 | 0 | 2.46s | |
| ✅ JSON | npm-package-json-lint | yes | no | no | 0.35s | |
| ✅ JSON | prettier | 21 | 4 | 0 | 0 | 0.53s |
| ✅ JSON | v8r | 21 | 0 | 0 | 6.9s | |
| ✅ MARKDOWN | markdownlint | 12 | 0 | 0 | 0 | 0.99s |
| ✅ MARKDOWN | markdown-table-formatter | 12 | 0 | 0 | 0 | 0.26s |
| ✅ REPOSITORY | checkov | yes | no | no | 17.65s | |
| ✅ REPOSITORY | gitleaks | yes | no | no | 0.51s | |
| ✅ REPOSITORY | git_diff | yes | no | no | 0.01s | |
| ✅ REPOSITORY | grype | yes | no | no | 28.07s | |
| ✅ REPOSITORY | secretlint | yes | no | no | 0.92s | |
| ✅ REPOSITORY | syft | yes | no | no | 1.85s | |
| ✅ REPOSITORY | trivy | yes | no | no | 7.63s | |
| ✅ REPOSITORY | trivy-sbom | yes | no | no | 0.23s | |
| ✅ REPOSITORY | trufflehog | yes | no | no | 2.3s | |
| lychee | 80 | 2 | 0 | 57.41s | ||
| ✅ YAML | prettier | 28 | 0 | 0 | 0 | 0.95s |
| ✅ YAML | v8r | 28 | 0 | 0 | 7.89s | |
| ✅ YAML | yamllint | 28 | 0 | 0 | 0.82s |
Detailed Issues
⚠️ SPELL / lychee - 2 errors
[IGNORED] docker://pandoc/extra:3.7.0@sha256:a703d335fa237f8fc3303329d87e2555dca5187930da38bfa9010fa4e690933a | Unsupported: Error creating request client: builder error for url (docker://pandoc/extra:3.7.0@sha256:a703d335fa237f8fc3303329d87e2555dca5187930da38bfa9010fa4e690933a)
[ERROR] https://docs.sigstore.dev/cosign/verifying/verify/ | Network error: error sending request for url (https://docs.sigstore.dev/cosign/verifying/verify/) Maybe a certificate error?
[IGNORED] https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer | Unsupported: Error creating request client: builder error for url (vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/philips-software/amp-devcontainer)
[403] https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads | Network error: Forbidden
📝 Summary
---------------------
🔍 Total..........126
✅ Successful.....122
⏳ Timeouts.........0
🔀 Redirected.......0
👻 Excluded.........0
❓ Unknown..........0
🚫 Errors...........2
Errors in README.md
[ERROR] https://docs.sigstore.dev/cosign/verifying/verify/ | Network error: error sending request for url (https://docs.sigstore.dev/cosign/verifying/verify/) Maybe a certificate error?
Errors in .github/TOOL_VERSION_ISSUE_TEMPLATE.md
[403] https://developer.arm.com/downloads/-/arm-gnu-toolchain-downloads | Network error: Forbidden
See detailed reports in MegaLinter artifacts
Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)
- Documentation: Custom Flavors
- Command:
npx mega-linter-runner@9.3.0 --custom-flavor-setup --custom-flavor-linters ACTION_ACTIONLINT,DOCKERFILE_HADOLINT,GHERKIN_GHERKIN_LINT,JSON_V8R,JSON_PRETTIER,JSON_NPM_PACKAGE_JSON_LINT,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_GRYPE,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,SPELL_LYCHEE,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
|
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
📦 Container Size AnalysisNote Comparing 📈 Size Comparison Table
|
Contributor
André Jordan (andjordan)
approved these changes
Jan 22, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to no response for status checks
github-merge-queue Bot
pushed a commit
that referenced
this pull request
Jan 22, 2026
* docs: update tool version issue template * docs: minor updates to template * docs: ignore MD041; first line should be a top-level heading
Contributor
Pull Request Report (#1096)Static measures
Time related measures
Status check related measures
|
Contributor
|
🎉 Hooray! The changes in this pull request went live with the release of v6.7.1 🎉 |
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.
🚀 Hey, I have created a Pull Request
Description of changes
This pull request improves the workflow for creating tool version evaluation issues by introducing a dedicated markdown template and updating the automation to use it. The changes make the process clearer, more maintainable, and easier for contributors to follow.
Workflow improvements:
.github/TOOL_VERSION_ISSUE_TEMPLATE.mdthat provides a detailed checklist, usage instructions, and notes for evaluating and updating tool versions. This replaces the previous inline issue body and makes future updates easier..github/workflows/issue-creation-tool-versions.ymlto use the new template file for issue creation, streamlining the process and ensuring consistency in issue formatting.Automation reliability:
Documentation and permissions:
✔️ Checklist