Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: cms deploy + meilisearch #2388

Merged
merged 5 commits into from
Jan 29, 2024
Merged

Fix: cms deploy + meilisearch #2388

merged 5 commits into from
Jan 29, 2024

Conversation

nmrgt
Copy link
Collaborator

@nmrgt nmrgt commented Jan 29, 2024

Summary by CodeRabbit

  • Chores
    • Updated deployment scripts to enhance compatibility with GitHub Actions syntax.
  • New Features
    • Integrated meilisearch support with configuration options for host and apiKey.
  • Refactor
    • Changed the default value of the nps flag in admin configuration to improve user experience.

@nmrgt nmrgt changed the title Fix: cms deploy Fix: cms deploy + meilisearch Jan 29, 2024
Copy link
Contributor

coderabbitai bot commented Jan 29, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (8)
  • cms/src/api/article/content-types/article/schema.json is excluded by: !**/*.json
  • cms/src/api/categorie/content-types/categorie/schema.json is excluded by: !**/*.json
  • cms/src/api/page/content-types/page/schema.json is excluded by: !**/*.json
  • cms/src/api/resource/content-types/resource/schema.json is excluded by: !**/*.json
  • cms/src/api/tag/content-types/tag/schema.json is excluded by: !**/*.json
  • cms/src/components/page/content.json is excluded by: !**/*.json
  • cms/src/components/page/resource.json is excluded by: !**/*.json
  • cms/src/components/page/row.json is excluded by: !**/*.json

Walkthrough

The recent updates involve modifications to the deployment workflow, CMS configuration, and plugin settings. Specifically, the deployment script now uses a more current syntax for setting output variables, and environment variables dictate CMS versioning. In the CMS configurations, the default behavior for the nps flag has been altered, and support for meilisearch with necessary credentials has been introduced, enhancing search capabilities.

Changes

File Path Change Summary
.github/workflows/deploy-cms.yml Updated syntax for setting output variables; added environment variables for CMS versioning.
cms/config/admin.ts Changed the default value of the nps flag from true to false.
cms/config/plugins.ts Added meilisearch configuration including host and apiKey.

🐰✨
Changes here, changes there,
Our code hops along without a care.
With each tweak and turn, we find our way,
A better search, a smoother day.
🌟📅

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

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>.
    • Generate unit-tests for this file.
  • 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 tests 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 generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between dd905c9 and 7c1a9de.
Files ignored due to path filters (2)
  • cms/package-lock.json is excluded by: !**/*.json
  • cms/package.json is excluded by: !**/*.json
Files selected for processing (3)
  • .github/workflows/deploy-cms.yml (2 hunks)
  • cms/config/admin.ts (1 hunks)
  • cms/config/plugins.ts (1 hunks)
Additional comments: 4
cms/config/admin.ts (1)
  • 14-14: The change to set the nps flag default value to false aligns with the PR objectives to adjust CMS configuration for a better user experience. Ensure that this change is communicated to stakeholders who might rely on NPS feedback being enabled by default.
cms/config/plugins.ts (1)
  • 30-35: The addition of meilisearch configuration with host and apiKey is a significant enhancement for the CMS's search capabilities. It's crucial to ensure that the MEILISEARCH_MASTER_KEY is securely managed and not exposed in any logs or error messages to prevent unauthorized access.
.github/workflows/deploy-cms.yml (2)
  • 22-22: Updating the syntax for setting output values to use $GITHUB_OUTPUT aligns with GitHub Actions best practices. This change enhances maintainability and future-proofs the workflow.
  • 54-55: The script now correctly sets the version and image for the deployment, ensuring that the correct CMS version is deployed. However, ensure that process.env.TARGET_VERSION is correctly accessible in this context. Typically, environment variables in GitHub Actions are accessed through ${{ env.VAR_NAME }}. Verify that process.env.TARGET_VERSION is the intended usage and works as expected in this workflow.

@Datayama38 Datayama38 merged commit e1a86cc into main Jan 29, 2024
5 checks passed
@Datayama38 Datayama38 deleted the fix/cms_deploy branch January 29, 2024 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants