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

Merge trunk into develop after the wp-parsely 3.16.3 release #2690

Merged
merged 8 commits into from
Aug 8, 2024

Conversation

acicovic
Copy link
Collaborator

@acicovic acicovic commented Aug 8, 2024

This PR merges the trunk branch into the develop branch after the release of wp-parsely 3.16.3.

Summary by CodeRabbit

  • New Features

    • Update to version 3.16.3, indicating the introduction of bug fixes and improvements.
  • Bug Fixes

    • Resolved an issue concerning undefined variable wpParselySmartLinkingAllowedBlocks in the PCH Smart Linking functionality, enhancing overall stability.
  • Documentation

    • Updated README and CHANGELOG files to reflect the new version and provide clarity on changes made.
  • Chores

    • Incremented version numbers across various project files to align with the new release.

@acicovic acicovic added this to the 3.17.0 milestone Aug 8, 2024
@acicovic acicovic self-assigned this Aug 8, 2024
Copy link
Contributor

coderabbitai bot commented Aug 8, 2024

Walkthrough

Walkthrough

The recent update to the Parse.ly WordPress plugin version 3.16.3 includes a critical fix for the PCH Smart Linking feature, addressing an issue with an undefined variable. This release also updates version numbers across various files, enhancing clarity and ensuring consistent tracking of functionalities. The changes ensure that the plugin is more robust and reliable while maintaining compatibility with existing systems.

Changes

Files Change Summary
CHANGELOG.md, README.md, package.json, wp-parsely.php Updated version number from 3.16.2 to 3.16.3, reflecting a new release that includes bug fixes.
src/.../smart-linking/smart-linking.tsx Modified export of ALLOWED_BLOCKS to include a default value using the nullish coalescing operator.
tests/e2e/utils.ts Updated PLUGIN_VERSION from '3.16.2' to '3.16.3', indicating the latest version for testing.

Possibly related issues

  • Release wp-parsely 3.16.3 #2686: This issue tracks the release of version 3.16.3, which aligns with the changes made in this PR, including fixes and updates.
  • Release wp-parsely 3.16.1 #2658: This issue discusses release tracking and might benefit from the recent updates, ensuring that all relevant tasks are completed for version 3.16.3.

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 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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.

@acicovic acicovic marked this pull request as ready for review August 8, 2024 10:56
@acicovic acicovic requested a review from a team as a code owner August 8, 2024 10:56
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.

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)
src/content-helper/editor-sidebar/smart-linking/smart-linking.tsx (1)

Line range hint 11-36:
Review JSDoc comments for completeness and accuracy.

The JSDoc comments are present but should include a @since tag for the new version of the plugin. Ensure that all JSDoc comments are complete and accurate.

/**
 * Default maximum number of links to show in the smart linking panel.
 *
 * @since 3.14.0
 */
+// @since 3.16.3
export const DEFAULT_MAX_LINKS = 10;

/**
 * The allowed blocks for Smart Linking.
 *
 * @since 3.16.2
 */
+// @since 3.16.3
export const ALLOWED_BLOCKS = window.wpParselySmartLinkingAllowedBlocks ?? [ 'core/paragraph' ];
Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e13c847 and 1a6698d.

Files ignored due to path filters (3)
  • build/content-helper/editor-sidebar.asset.php is excluded by !build/**
  • build/content-helper/editor-sidebar.js is excluded by !build/**
  • package-lock.json is excluded by !**/package-lock.json
Files selected for processing (6)
  • CHANGELOG.md (1 hunks)
  • README.md (1 hunks)
  • package.json (1 hunks)
  • src/content-helper/editor-sidebar/smart-linking/smart-linking.tsx (1 hunks)
  • tests/e2e/utils.ts (1 hunks)
  • wp-parsely.php (2 hunks)
Files skipped from review due to trivial changes (5)
  • CHANGELOG.md
  • README.md
  • package.json
  • tests/e2e/utils.ts
  • wp-parsely.php
Additional context used
Path-based instructions (1)
src/content-helper/editor-sidebar/smart-linking/smart-linking.tsx (1)

Pattern **/*.{js,ts,tsx,jsx}: "Perform a detailed review of the provided code with following key aspects in mind:

  • Review the code to ensure it is well-structured and adheres to best practices.
  • Verify compliance with WordPress coding standards.
  • Ensure the code is well-documented.
  • Check for security vulnerabilities and confirm the code is secure.
  • Optimize the code for performance, removing any unnecessary elements.
  • Validate JSDoc comments for accuracy, currency, and adherence to WordPress coding standards.
  • Ensure each line comment concludes with a period.
  • Confirm every JSDoc comment includes a @SInCE tag indicating the next version of the plugin to include the code.
  • Guarantee compatibility with the latest version of WordPress, avoiding deprecated functions or features."
Additional comments not posted (3)
src/content-helper/editor-sidebar/smart-linking/smart-linking.tsx (3)

38-38: Robustness improvement with nullish coalescing.

The use of the nullish coalescing operator ensures that ALLOWED_BLOCKS always has a valid value, preventing potential runtime errors if window.wpParselySmartLinkingAllowedBlocks is null or undefined. This is a good practice for enhancing code robustness.


Line range hint 1-8:
Ensure compliance with WordPress coding standards.

The import statements and usage of WordPress dependencies appear to follow WordPress coding standards. Ensure that all dependencies are up-to-date and compatible with the latest WordPress version.


38-38: Security check for usage of global variables.

The use of window.wpParselySmartLinkingAllowedBlocks should be verified to ensure it doesn't introduce security vulnerabilities. Validate that this global variable is properly sanitized and controlled.

@acicovic acicovic merged commit a8afcf5 into develop Aug 8, 2024
37 checks passed
@acicovic acicovic deleted the merge/trunk-into-develop-after-1.16.3 branch August 8, 2024 13:42
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