Skip to content

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

docs: unify documentation workflows with improved validation #17523

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ef93173
refactor: implement docs workflow with MegaLinter and standardized ac…
EdwardAngert Apr 24, 2025
83b45fc
fix: correct variable syntax in workflow YAML
EdwardAngert Apr 24, 2025
4142800
fix: resolve YAML syntax issues and add Vale configuration
EdwardAngert Apr 24, 2025
ae27582
style: improve YAML formatting in docs workflow
EdwardAngert Apr 24, 2025
b2ffe85
fix: add Node.js setup to docs-unified workflow
EdwardAngert Apr 24, 2025
6b714ec
fix: secure GitHub Actions workflow to pass actionlint
EdwardAngert Apr 24, 2025
6eb9c32
feat: enhance PR comments with timestamps and progress updates
EdwardAngert Apr 24, 2025
ae66052
fix: use platform-compatible date formatting in workflow
EdwardAngert Apr 24, 2025
36e6ef0
feat: simplify PR comment system in docs workflow
EdwardAngert Apr 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: secure GitHub Actions workflow to pass actionlint 
- 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
  • Loading branch information
@EdwardAngert
EdwardAngert committed Apr 24, 2025
commit 6b714ec6da3febfe810c198c2bd13d73d9d903bf
20 changes: 13 additions & 7 deletions .github/workflows/docs-unified.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,27 +250,33 @@ jobs:
# Extract context information for PR/branch
- name: Extract context information
id: context-info
env:
INPUT_PR_NUMBER: ${{ inputs.pr-number }}
GITHUB_EVENT_NAME: ${{ github.event_name }}
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
GITHUB_HEAD_REF: ${{ github.head_ref }}
GITHUB_REF_NAME: ${{ github.ref_name }}
shell: bash
run: |
echo "::group::Extracting context information"

# Extract PR number from inputs or context
if [ -n "${{ inputs.pr-number }}" ]; then
PR_NUMBER="${{ inputs.pr-number }}"
if [ -n "$INPUT_PR_NUMBER" ]; then
PR_NUMBER="$INPUT_PR_NUMBER"
echo "::notice::Using PR number from action input: #${PR_NUMBER}"
elif [ "${{ github.event_name }}" == "pull_request" ]; then
PR_NUMBER="${{ github.event.pull_request.number }}"
elif [ "$GITHUB_EVENT_NAME" == "pull_request" ]; then
PR_NUMBER="$GITHUB_PR_NUMBER"
echo "::notice::Using PR number from event context: #${PR_NUMBER}"
else
echo "::notice::No PR number available. Features requiring PR number will be disabled."
PR_NUMBER=""
fi

# Extract branch information (used for preview URLs)
if [ "${{ github.event_name }}" == "pull_request" ]; then
BRANCH_NAME="${{ github.head_ref }}"
if [ "$GITHUB_EVENT_NAME" == "pull_request" ]; then
BRANCH_NAME="$GITHUB_HEAD_REF"
else
BRANCH_NAME="${{ github.ref_name }}"
BRANCH_NAME="$GITHUB_REF_NAME"
fi

# Sanitize branch name for URLs
Expand Down
Loading