feat: add gitlab runner example with Zephyr

[Nsttt]

What's added in this PR?

This PR adds documentation to use Zephyr inside a Gitlab Runner context.

(Required) Pre-PR/Merge checklist

• I have added/updated our feature to sync with this PR
• I have added an explanation of my changes
• I have/will run tests, or ask for help to add test

[claude]

Claude finished @Nsttt's task —— View job

---

Pull Request Review Complete

Purpose Summary: This PR adds comprehensive GitLab Runner documentation for integrating Zephyr with GitLab CI/CD pipelines, including token management, pipeline configuration, and troubleshooting guidance.

Todo List:

• Read repository guidelines (CLAUDE.md)
• Analyze new documentation file (docs/how-to/gitlab-automations.mdx)
• Review config changes (rspress.config.ts)
• Check for security considerations
• Evaluate documentation quality and accuracy
• Provide structured feedback with severity table
• Give overall quality score and recommendations

---

Review Findings

Severity	Line(s)	Issue	Recommendation
Medium	31, 45, 94, 105	Redundant variable declarations in GitLab CI YAML	Remove explicit ZE_SECRET_TOKEN: $ZE_SECRET_TOKEN declarations since GitLab automatically injects CI/CD variables as environment variables
Low	61-106	Pipeline example uses deprecated only syntax	Replace only: - main with modern rules syntax for better flexibility
Low	71	Cache key uses deprecated variable	Consider using ${CI_COMMIT_REF_NAME} instead of ${CI_COMMIT_REF_SLUG} for clearer intent
Low	78	Uses npm ci but then caches node_modules/	Either use npm ci with no node_modules/ caching, or use npm install with caching

Detailed Code Improvements

1. Remove Redundant Variable Declarations

Current (lines 31, 45, 94, 105):

variables:
  ZE_SECRET_TOKEN: $ZE_SECRET_TOKEN

Recommended:

# Remove this entirely - GitLab automatically injects CI/CD variables

2. Modernize Pipeline Syntax

Current (lines 100-101):

only:
  - main

Recommended:

rules:
  - if: $CI_COMMIT_BRANCH == "main"

3. Fix Caching Strategy

Current (lines 77-83):

install:
  stage: install
  script:
    - npm ci --cache .npm --prefer-offline
  artifacts:
    paths:
      - node_modules/

Recommended Option A (Pure npm ci):

install:
  stage: install
  script:
    - npm ci --cache .npm --prefer-offline
  # Remove node_modules/ from artifacts

Recommended Option B (With caching):

install:
  stage: install
  script:
    - npm install --cache .npm --prefer-offline
  artifacts:
    paths:
      - node_modules/

---

Security Assessment ✅

Strengths:

• ✅ Properly recommends masking sensitive variables
• ✅ Advises using protected variables for protected branches
• ✅ Includes security considerations in troubleshooting
• ✅ Links to secure token generation page

No critical security issues found.

---

Quality Assessment

Strengths:

• ✅ Clear, step-by-step instructions
• ✅ Comprehensive troubleshooting section
• ✅ Good use of code examples and formatting
• ✅ Proper navigation integration in config
• ✅ Consistent with existing documentation style

Areas for improvement:

• 🔄 Remove redundant variable declarations
• 🔄 Update to modern GitLab CI syntax
• 🔄 Clarify caching strategy

---

Overall Quality Score: 7.5/10

Top 3 Next Steps:

1. Remove redundant variable declarations - This will simplify the examples and reduce confusion
2. Update GitLab CI syntax to modern standards - Replace only with rules for better maintainability
3. Clarify npm caching strategy - Choose either npm ci without caching or npm install with caching

Recommendation: ✅ Approve with minor revisions

This is solid documentation that will help users integrate Zephyr with GitLab Runner. The issues found are minor and primarily focus on following current best practices rather than correctness problems.

---

[alwaysmeticulous]

🤖 No test run has been triggered as your Meticulous project has been deactivated (since you haven't viewed any test results in a while). Click here to reactivate.

_{Last updated for commit a8105a6. This comment will update as new commits are pushed.}

[claude]

Claude finished @Nsttt's task —— View job

---

Pull Request Review Complete

Purpose Summary: This PR adds comprehensive GitLab Runner documentation for integrating Zephyr with GitLab CI/CD pipelines, including token management, pipeline configuration, and troubleshooting guidance.

Todo List:

• Read repository guidelines (CLAUDE.md) - No CLAUDE.md found
• Analyze new documentation file (docs/how-to/gitlab-automations.mdx)
• Review config changes (rspress.config.ts)
• Check for security considerations
• Evaluate documentation quality and accuracy
• Provide structured feedback with severity table
• Give overall quality score and recommendations

---

Review Findings

Severity	Line(s)	Issue	Recommendation
Medium	31, 45, 94, 105	Redundant variable declarations in GitLab CI YAML	Remove explicit ZE_SECRET_TOKEN: $ZE_SECRET_TOKEN declarations since GitLab automatically injects CI/CD variables as environment variables
Low	100-101	Pipeline example uses deprecated only syntax	Replace only: - main with modern rules syntax for better flexibility
Low	71	Cache key uses deprecated variable	Consider using ${CI_COMMIT_REF_NAME} instead of ${CI_COMMIT_REF_SLUG} for clearer intent
Low	78-82	Uses npm ci but then caches node_modules/	Either use npm ci with no node_modules/ caching, or use npm install with caching

Detailed Code Improvements

1. Remove Redundant Variable Declarations

Current (lines 31, 45, 94, 105):

variables:
  ZE_SECRET_TOKEN: $ZE_SECRET_TOKEN

Recommended:

# Remove this entirely - GitLab automatically injects CI/CD variables

2. Modernize Pipeline Syntax

Current (lines 100-101):

only:
  - main

Recommended:

rules:
  - if: $CI_COMMIT_BRANCH == "main"

3. Fix Caching Strategy

Current (lines 77-83):

install:
  stage: install
  script:
    - npm ci --cache .npm --prefer-offline
  artifacts:
    paths:
      - node_modules/

Recommended Option A (Pure npm ci):

install:
  stage: install
  script:
    - npm ci --cache .npm --prefer-offline
  # Remove node_modules/ from artifacts

Recommended Option B (With caching):

install:
  stage: install
  script:
    - npm install --cache .npm --prefer-offline
  artifacts:
    paths:
      - node_modules/

---

Security Assessment ✅

Strengths:

• ✅ Properly recommends masking sensitive variables
• ✅ Advises using protected variables for protected branches
• ✅ Includes security considerations in troubleshooting
• ✅ Links to secure token generation page

No critical security issues found.

---

Quality Assessment

Strengths:

• ✅ Clear, step-by-step instructions
• ✅ Comprehensive troubleshooting section
• ✅ Good use of code examples and formatting
• ✅ Proper navigation integration in config
• ✅ Consistent with existing documentation style

Areas for improvement:

• 🔄 Remove redundant variable declarations
• 🔄 Update to modern GitLab CI syntax
• 🔄 Clarify caching strategy

---

Overall Quality Score: 7.5/10

Top 3 Next Steps:

1. Remove redundant variable declarations - This will simplify the examples and reduce confusion
2. Update GitLab CI syntax to modern standards - Replace only with rules for better maintainability
3. Clarify npm caching strategy - Choose either npm ci without caching or npm install with caching

Recommendation: ✅ Approve with minor revisions

This is solid documentation that will help users integrate Zephyr with GitLab Runner. The issues found are minor and primarily focus on following current best practices rather than correctness problems.

---