Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: unify documentation workflows with improved validation#17523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Closed
EdwardAngert wants to merge9 commits intomainfromunified-docs-workflow

Conversation

EdwardAngert
Copy link
Contributor

This PR is a replacement for#17522 with a branch name that works better with our docs preview system.

Summary

  • Combine all documentation validation workflows into a unified approach
  • Fix errors in lychee-action configuration for link checking
  • Remove duplicate example workflows
  • Fix caching issues in build process
  • Update branch name format for docs preview URLs

Test plan

  • Verify all documentation workflows run without errors
  • Test docs preview URLs work correctly
  • Ensure link checking functions properly

Note: This branch replaces feature/unified-docs-workflow-combined to resolve docs preview URL issues.

@EdwardAngertEdwardAngert changed the titleUnify documentation workflows and fix link checkingdocs: unify documentation workflows with improved validationApr 23, 2025
@EdwardAngertEdwardAngert added the docs/sitedocs site-related issue/task/feature request labelApr 23, 2025
@EdwardAngertEdwardAngert marked this pull request as draftApril 23, 2025 06:44
@github-actionsGitHub Actions
Copy link

github-actionsbot commentedApr 23, 2025
edited
Loading

📚 Docs Preview

Your documentation changes are available for preview at:
🔗Documentation Preview

Quick Links

Here are direct links to key documentation pages:

Note: Branch names with slashes (e.g.,username/feature) are converted to dashes (e.g.,username-feature) in the preview URL.

📋 Show documentation validation status

The detailed validation status is available in the "Documentation Validation" check in this PR. Common issues and solutions:

  • Link issues: Runpnpm run docs:check-links locally
  • Style issues: Runpnpm run docs:fix locally
  • Cross-reference issues: Check heading IDs and link references

🤖 This comment is automatically generated and updated when documentation changes.

github-actions[bot] and EdwardAngert reacted with eyes emoji

Copy link
Member

@matifalimatifali left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I am ok with this. But we need to fix all action version to latest commit hashes see how its done inci.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 tofalse 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 No newline at end of file
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I would also addjetbrains: JetBrains and other partner or integration vendor names in the correct case. Likejfrog: JFrog

EdwardAngert reacted with thumbs up emoji
…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
- 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
@github-actionsgithub-actionsbot added the staleThis issue is like stale bread. labelMay 3, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@matifalimatifalimatifali approved these changes

Assignees

@EdwardAngertEdwardAngert

Labels
docs/sitedocs site-related issue/task/feature requeststaleThis issue is like stale bread.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@EdwardAngert@matifali

[8]ページ先頭

©2009-2025 Movatter.jp