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

Added contentVisibilityAlpha flag #22042

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Conversation

kevinansfield
Copy link
Member

no issue

  • flag to allow internal testing of content visibility developments without unintentional early release to beta testers

no issue

- flag to allow internal testing of content visibility developments without unintentional early release to beta testers
Copy link

coderabbitai bot commented Jan 22, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

apps/admin-x-settings/src/components/settings/advanced/labs/AlphaFeatures.tsx

Oops! Something went wrong! :(

ESLint: 8.44.0

ESLint couldn't find the plugin "eslint-plugin-react-hooks".

(The package "eslint-plugin-react-hooks" was not found when loaded as a Node module from the directory "/apps/admin-x-settings".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react-hooks@latest --save-dev

The plugin "eslint-plugin-react-hooks" was referenced from the config file in "apps/admin-x-settings/.eslintrc.cjs".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces a new alpha feature called 'Content Visibility (Alpha)' across multiple files in the Ghost project. This involves adding a new feature flag contentVisibilityAlpha to the system's configuration, enabling potential experimental functionality related to content visibility in emails. The changes span configuration files, feature services, and admin settings, preparing the groundwork for a new experimental feature without disrupting existing system functionality.

Changes

File Change Summary
apps/admin-x-settings/src/components/settings/advanced/labs/AlphaFeatures.tsx Updated features array with 'Content Visibility (Beta)' and added new 'Content Visibility (Alpha)' entry
ghost/admin/app/components/koenig-lexical-editor.js Added contentVisibilityAlpha to defaultCardConfig
ghost/admin/app/services/feature.js Introduced new feature flag @feature('contentVisibilityAlpha')
ghost/core/core/shared/labs.js Added 'contentVisibilityAlpha' to ALPHA_FEATURES array

Sequence Diagram

sequenceDiagram
    participant Labs as Labs Configuration
    participant Feature as Feature Service
    participant Editor as Koenig Lexical Editor
    participant AdminSettings as Admin X Settings

    Labs->>Feature: Define contentVisibilityAlpha flag
    Feature->>Editor: Configure contentVisibilityAlpha
    Editor->>AdminSettings: Expose feature in Alpha Features
    AdminSettings->>User: Display new alpha feature option
Loading

📜 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 c8e76fb and 93d4b08.

⛔ Files ignored due to path filters (1)
  • ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap is excluded by !**/*.snap
📒 Files selected for processing (4)
  • apps/admin-x-settings/src/components/settings/advanced/labs/AlphaFeatures.tsx (1 hunks)
  • ghost/admin/app/components/koenig-lexical-editor.js (1 hunks)
  • ghost/admin/app/services/feature.js (1 hunks)
  • ghost/core/core/shared/labs.js (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (7)
  • GitHub Check: Ghost-CLI tests
  • GitHub Check: Database tests (Node 20.11.1, sqlite3)
  • GitHub Check: Regression tests (Node 20.11.1, mysql8)
  • GitHub Check: Database tests (Node 20.11.1, mysql8)
  • GitHub Check: Database tests (Node 18.12.1, mysql8)
  • GitHub Check: Admin-X Settings tests
  • GitHub Check: Admin tests - Chrome
🔇 Additional comments (4)
apps/admin-x-settings/src/components/settings/advanced/labs/AlphaFeatures.tsx (1)

43-50: LGTM! Clear distinction between Beta and Alpha features.

The implementation correctly:

  • Separates beta and alpha features
  • Documents the dependency requirement
  • Maintains consistent structure with other feature entries
ghost/core/core/shared/labs.js (1)

54-55: LGTM! Correct placement in ALPHA_FEATURES array.

The feature flag is appropriately placed in the ALPHA_FEATURES array, maintaining consistency with the PR's objective of internal testing.

ghost/admin/app/services/feature.js (1)

77-77: LGTM! Consistent feature service implementation.

The contentVisibilityAlpha feature is correctly implemented using the @feature decorator and logically placed near the related contentVisibility feature.

ghost/admin/app/components/koenig-lexical-editor.js (1)

444-445: LGTM! Consistent editor configuration.

The contentVisibilityAlpha feature flag is correctly added to the editor configuration, maintaining consistency with the related contentVisibility feature.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

🪧 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.

@kevinansfield kevinansfield enabled auto-merge (rebase) January 22, 2025 07:09
@kevinansfield kevinansfield merged commit 3a38aef into main Jan 22, 2025
22 checks passed
@kevinansfield kevinansfield deleted the content-visibility-alpha branch January 22, 2025 07:17
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.

1 participant