Include Orama Search! #45

UlisesGascon · 2025-06-04T15:18:28Z

Preview

Summary by CodeRabbit

New Features
- Integrated analytics and enhanced search capabilities with a new plugin, allowing for customizable search box text and analytics support.
Chores
- Added support for environment variables across configuration and build processes.
- Updated dependencies to include analytics and environment variable management tools.
- Improved workflow configurations for building and deploying the site.
- Updated .gitignore to exclude generic environment files.

coderabbitai · 2025-06-04T15:18:35Z

Walkthrough

Environment variable management was enhanced across the project. The .env file is now ignored in version control. GitHub Actions workflows for building and deploying set specific secrets as environment variables during build steps. Docusaurus configuration now loads environment variables using dotenv and integrates the @orama/plugin-docusaurus-v3 plugin, with related dependencies added.

Changes

File(s)	Change Summary
.github/workflows/ci.yml, .../deploy.yml	Updated build steps to pass three secrets as environment variables: `ORAMA_CLOUD_PRIVATE_API_KEY`, `ORAMA_CLOUD_INDEX_ID`, and `ENABLE_ORAMA_CLOUD_DEPLOY`.
.gitignore	Added `.env` to ignored files.
docusaurus.config.js	Required `dotenv`, added `@orama/plugin-docusaurus-v3` plugin configuration with env variables, reformatted imports and spacing.
package.json	Added `@orama/plugin-docusaurus-v3` and `dotenv` to dependencies.

Sequence Diagram(s)

sequenceDiagram
    participant GitHub Actions
    participant Build Step
    participant Environment
    participant Docusaurus

    GitHub Actions->>Build Step: Trigger build/deploy workflow
    Build Step->>Environment: Set env vars from secrets (.env or GitHub secrets)
    Build Step->>Docusaurus: Run npm build (with env vars)
    Docusaurus->>Docusaurus: Load env vars via dotenv
    Docusaurus->>Docusaurus: Initialize @orama/plugin-docusaurus-v3 with env vars

Poem

🐇
Secrets now flow where they need to be,
With dotenv and Orama, search runs free.
The .env is hidden, safe from the crowd,
While builds and deploys wear variables proud.
Hopping along, our docs grow bright—
With plugins and configs, all set just right!

📜 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 e2960d1 and e64d7c6.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (1)

package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

package.json

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@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.

coderabbitai

Actionable comments posted: 2

🧹 Nitpick comments (1)

.github/workflows/ci.yml (1)
30-30: Fix trailing whitespace.

Static analysis detected trailing spaces on this line.
-      
+
🧰 Tools

🪛 YAMLlint (1.37.1)

[error] 30-30: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 785b34f and 3273342.

⛔ Files ignored due to path filters (1)

package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (5)

.github/workflows/ci.yml (1 hunks)
.github/workflows/deploy.yml (1 hunks)
.gitignore (1 hunks)
docusaurus.config.js (5 hunks)
package.json (1 hunks)

🧰 Additional context used

🪛 YAMLlint (1.37.1)

.github/workflows/ci.yml

[error] 30-30: trailing spaces

(trailing-spaces)

🔇 Additional comments (5)

.gitignore (1)

13-13: Good security practice!

Adding .env to gitignore is essential to prevent accidentally committing sensitive environment variables like the Orama API keys used in this project.

.github/workflows/ci.yml (1)

26-29: Environment variable configuration looks good.

Properly configuring Orama secrets as environment variables during the build step ensures the plugin can access necessary credentials while maintaining security through GitHub secrets.

.github/workflows/deploy.yml (1)

26-29: Consistent and secure environment variable configuration.

The deployment workflow correctly mirrors the CI workflow's environment variable setup, ensuring the Orama plugin has access to necessary credentials during site deployment.

docusaurus.config.js (2)

1-1: Proper environment variable loading.

Adding dotenv configuration enables loading environment variables from .env files, which is essential for local development of the Orama integration.

79-82: Minor formatting improvements applied.

The spacing and formatting adjustments improve code consistency throughout the configuration file.

Also applies to: 90-90, 100-102

package.json

docusaurus.config.js

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

UlisesGascon added 4 commits June 4, 2025 17:06

deps: include @orama/plugin-docusaurus-v3@^3.1.7 and dotenv@^16.5.0

c84ade6

feat: enable Orama in the website

71477f5

chore: ignore .env files in git

298e289

ci: include orama secrets reference

3273342

UlisesGascon self-assigned this Jun 4, 2025

coderabbitai bot reviewed Jun 4, 2025

View reviewed changes

package.json Outdated Show resolved Hide resolved

docusaurus.config.js Show resolved Hide resolved

UlisesGascon and others added 2 commits June 4, 2025 17:29

Update docusaurus.config.js

e2960d1

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

deps: include @orama/[email protected]

e64d7c6

UlisesGascon merged commit 983fb66 into main Jun 4, 2025
2 checks passed

UlisesGascon deleted the orama branch June 4, 2025 17:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Include Orama Search! #45

Include Orama Search! #45

Uh oh!

UlisesGascon commented Jun 4, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jun 4, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Include Orama Search! #45

Include Orama Search! #45

Uh oh!

Conversation

UlisesGascon commented Jun 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Preview

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

UlisesGascon commented Jun 4, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)