docs: unify documentation workflows with improved validation #17523
Conversation
📚 Docs PreviewYour documentation changes are available for preview at: Quick LinksHere are direct links to key documentation pages:
📋 Show documentation validation statusThe detailed validation status is available in the "Documentation Validation" check in this PR. Common issues and solutions:
🤖 This comment is automatically generated and updated when documentation changes. |
There was a problem hiding this comment.
I am ok with this. But we need to fix all action version to latest commit hashes see how its done in ci.yaml
The PR looks too big. SO would prefer if we reduce the size and remove features we are not using. I ave seen for docs-shared action that many inputs were set to false when used. So it would be nice to remove any features from the actions we do not use anywhere.
| "sign[ -]in": sign in | ||
| "ssh key": SSH key | ||
| "two factor": two-factor | ||
| "web ?hook": webhook |
There was a problem hiding this comment.
I would also add jetbrains: JetBrains and other partner or integration vendor names in the correct case. Like jfrog: JFrog
edb8ec7 to
3e53553
Compare
…tions - Replace custom implementation with MegaLinter documentation flavor - Use tj-actions/changed-files for file detection - Create standard configuration files for all tools - Remove complex composite action in favor of pipeline approach - Update documentation to reflect new architecture - Add testing script for validation - Fix Vale style checking implementation - Cleanup documentation files
3e53553 to
ef93173
Compare
- Fixed YAML syntax in docs-unified.yaml workflow - Added Vale configuration with basic style rules - Created template file approach for PR comment to avoid syntax issues - Ensured proper Vale directory structure
- Added YAML document start marker - Removed trailing whitespace - Added newline at end of file
- Added Node.js setup step in the workflow to resolve errors with pnpm installation - Uses existing ./.github/actions/setup-node action to maintain consistency with other workflows
- Follow security best practice for GitHub Actions - Pass potentially untrusted context values via environment variables - Fixes actionlint warning about using github.head_ref directly in scripts
- Add timestamps to initial, in-progress, and completion comments - Add a comment update after file detection to show progress - Improve user experience with better status messaging - Allow tracking of workflow progress through multiple stages
- Fix date formatting to be compatible with GitHub Actions runners (Linux) - Use TZ=UTC instead of -u flag for better compatibility - Remove unnecessary timestamp environment variable - Ensure all date commands use the same format
- Use peter-evans/create-or-update-comment action for PR comments - Replace marocchino/sticky-pull-request-comment with established pattern - Remove complex date formatting and temporary file management - Add find-comment action to track PR comments consistently - Follow existing workflow patterns from PR deploy workflow
This PR is a replacement for #17522 with a branch name that works better with our docs preview system.
Summary
Test plan
Note: This branch replaces feature/unified-docs-workflow-combined to resolve docs preview URL issues.