ci: add build v3 scripts

[kagol]

PR

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our Commit Message Guidelines
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

• Bugfix
• Feature
• Code style update (formatting, local variables)
• Refactoring (no functional changes, no api changes)
• Build related changes
• CI related changes
• Documentation content changes
• Other... Please describe:

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

• Yes
• No

Other information

Summary by CodeRabbit

• New Features
  • Introduced new build commands to generate version 3 documentation.
  • Enabled dynamic base URL configuration via environment variables for enhanced deployment flexibility.

[coderabbitai]

Walkthrough

The changes introduce a new build command for version 3 documentation across multiple package.json files. An environment variable, VITE_BASE_URL, is added in the Vite configuration file (.env.v3), and the Vitepress config is updated to load this variable dynamically using loadEnv. The new build scripts and dynamic base URL configuration allow the documentation to be built with settings specific to version 3.

Changes

File(s)	Change Summary
package.json, packages/docs/package.json	Added new build:v3 script commands to build documentation for version 3.
packages/docs/fluent-editor/.env.v3	Added the environment variable VITE_BASE_URL with value /.
packages/docs/fluent-editor/.vitepress/config.ts	Integrated loadEnv from Vitepress to dynamically set the base property using VITE_BASE_URL, defaulting to /tiny-editor/ if not provided.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant RP as Root package.json
    participant DP as Docs package.json
    participant Env as .env.v3
    participant CT as Vitepress Config
    participant VP as Vitepress Build Process

    U->>RP: Execute "build:v3" command
    RP->>DP: Invoke docs build script
    DP->>Env: Load environment variables
    Env->>CT: Provide VITE_BASE_URL
    CT->>VP: Configure base URL dynamically
    VP->>U: Complete documentation build

Loading

Suggested labels

v3

Poem

I'm a bunny with code in my nest,
New build commands make my heart beat at its best.
With VITE_BASE_URL set to light my way,
Vitepress hops to build a brighter day.
Hop along, build v3—it's a joyful coding play! 🐇

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3ebe740 and b39ea0d.

📒 Files selected for processing (4)

• package.json (1 hunks)
• packages/docs/fluent-editor/.env.v3 (1 hunks)
• packages/docs/fluent-editor/.vitepress/config.ts (1 hunks)
• packages/docs/package.json (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• packages/docs/fluent-editor/.env.v3

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: test

🔇 Additional comments (5)

package.json (1)

31-31: Build script addition looks good!

The new build:v3 script follows the project's existing pattern for workspace commands and correctly delegates to the corresponding script in the docs package.

packages/docs/package.json (1)

9-9:

✅ Verification successful

Build script for v3 works but has Node.js version dependency.

The script correctly loads environment variables from .env.v3 for building version 3 documentation. Note that the --env-file flag requires Node.js ≥ 20.6.0.

Consider adding a note about the Node.js version requirement in the project documentation, or you could verify compatibility with:

---

🏁 Script executed:

#!/bin/bash
node -v
node -h | grep -A 2 "env-file"

Length of output: 304

---

Build script for v3 validated and approved.
The script in packages/docs/package.json correctly invokes the VitePress CLI with the specified .env.v3 file—this has been confirmed by verifying that the --env-file flag is supported in Node v22.9.0 (which exceeds the minimum requirement of v20.6.0).

• The build command appropriately loads environment variables.
• The node version output confirms compatibility.
• It’s advisable to note in the project documentation that the --env-file flag requires Node.js ≥ 20.6.0.

packages/docs/fluent-editor/.vitepress/config.ts (3)

3-3: Import and usage of loadEnv function looks good.

The addition of loadEnv from vitepress allows for dynamic configuration based on environment variables.

Also applies to: 6-6

---

12-12: Dynamic base URL implementation is good.

The approach of using an environment variable with a fallback value for the base URL is a good practice for supporting different deployment environments.

---

6-6:

❓ Verification inconclusive

Verify loadEnv usage pattern.

The loadEnv function's first parameter typically expects a mode string ('production', 'development', etc.) rather than an environment variable. Consider using:

-const env = loadEnv(process.env.VITE_BASE_URL, fileURLToPath(new URL('../', import.meta.url)))
+const env = loadEnv('production', fileURLToPath(new URL('../', import.meta.url)))

This would look for .env.production files in the specified directory.

Check how loadEnv is being used in the VitePress documentation:

---

🏁 Script executed:

#!/bin/bash
# Look for loadEnv examples in the VitePress repo
curl -s "https://api.github.com/search/code?q=loadEnv+repo:vuejs/vitepress" | jq '.items[] | {path: .path, url: .html_url}'

Length of output: 184

---

Action required: Manually verify the loadEnv parameter usage.

The current code:

const env = loadEnv(process.env.VITE_BASE_URL, fileURLToPath(new URL('../', import.meta.url)))

passes an environment variable as the first argument. However, per VitePress (and Vite) conventions, the first argument should be a mode string (e.g., 'production' or 'development'). This discrepancy may lead to an incorrect environment file loading.

• Suggested change:

-const env = loadEnv(process.env.VITE_BASE_URL, fileURLToPath(new URL('../', import.meta.url)))
+const env = loadEnv('production', fileURLToPath(new URL('../', import.meta.url)))

Please verify that using a fixed mode string (or an appropriately computed mode) aligns with your project’s intended behavior. If your setup truly requires an environment variable here, ensure that its value correctly maps to a valid mode. Manual confirmation is recommended given that our automated lookup did not yield conclusive results.

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.