Skip to content

Update readme for v6.20#2307

Merged
Crabcyborg merged 1 commit into
masterfrom
update_readme_6.20
Apr 8, 2025
Merged

Update readme for v6.20#2307
Crabcyborg merged 1 commit into
masterfrom
update_readme_6.20

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

No description provided.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 8, 2025

Walkthrough

This pull request updates the version information to 6.20 in both the changelog and readme files. The changes include multiple fixes and enhancements such as security improvements to prevent email shortcode reprocessing, automated availability of free form templates, admin page enhancements for smaller screens, GDPR field text support for hyperlinks, currency formatting fixes, CSS variable validation, and stricter data serialization checks. Additionally, the preview page for the default contact form is now access-restricted with a new frm_block_preview filter for managing form visibility.

Changes

Files Change Summary
changelog.txt, readme.txt - Updated version information to 6.20
- Added detailed release notes covering security fixes (e.g., preventing multiple shortcode processing in emails), new free form templates, admin page usability improvements, GDPR text hyperlink support, currency formatting corrections, CSS validation enhancements, and preview page access restrictions with a new filter (frm_block_preview)
- Readme updated with a stable tag change from 6.19 to 6.20

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant FP as Form Preview Page
    participant F as frm_block_preview Filter

    U->>FP: Request preview page with key
    FP->>F: Validate access key
    alt Valid key
        F-->>FP: Access granted
        FP-->>U: Display form preview
    else Invalid key
        F-->>FP: Access denied
        FP-->>U: Show error or blank page
    end
Loading

Possibly related PRs


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.
    • 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

Copy link
Copy Markdown
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: 0

🧹 Nitpick comments (2)
readme.txt (1)

375-388: Changelog Section for Version 6.20 – Minor Language Improvements Suggested
The changelog provides a comprehensive list of fixes and new features for version 6.20. Below are a few suggestions to enhance clarity and maintain consistency:

  • Line 380: The phrase “using thousand separators that are not a decimal or a comma” could be revised for improved readability. For instance, consider:
    -* Fix: Calculations based on currency formatted values would break using thousand separators that are not a decimal or a comma.
    +* Fix: Calculations based on currency formatted values would break when using separators for thousands that are neither a decimal point nor a comma.
  • Line 384: There appears to be a potential missing comma that might impact the sentence flow. Verify if adding a comma after “querying issues” improves clarity.
  • Line 387: The word “automatically” is used twice in quick succession. Rephrasing to avoid repetition can enhance readability. For example:
    -* The preview page for the contact form that gets installed automatically on every site is now automatically blocked from anyone without access to view the forms list. In addition, the preview page will no longer display a form when an incorrect key is used. This is to help prevent spam that targets the default form. A new frm_block_preview filter has been added which can be used to unblock the default form, and to block additional forms.
    +* The preview page for the contact form that gets installed on every site is now blocked from users who lack the proper viewing permissions. Additionally, it will no longer display a form when an incorrect key is used, helping to prevent spam targeting the default form. A new frm_block_preview filter has been added to allow unblocking the default form or blocking other forms as needed.
🧰 Tools
🪛 LanguageTool

[grammar] ~380-~380: Use “a thousand”, or use a number before ‘thousand’.
Context: ...ency formatted values would break using thousand separators that are not a decimal or a ...

(NODT_DOZEN)


[uncategorized] ~384-~384: Possible missing comma found.
Context: ...conflict with WPML would cause querying issues resulting in empty results when checkin...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~387-~387: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...lled automatically on every site is now automatically blocked from anyone without access to v...

(ADVERB_REPETITION_PREMIUM)

changelog.txt (1)

1-15: Review of the v6.20 Changelog Entry

The new entry for version 6.20 is well positioned at the top and clearly lists the major updates. Here are some targeted points:

  • Security Improvement:
    • The note regarding shortcodes in emails being processed more than once is clear. Confirm that the underlying fix fully prevents such multiple processing.
    *Tag: *

  • New Free Form Templates:
    • The entry “Over 30 free form templates are now available automatically for all users…” is succinct and informs the reader of a significant UX enhancement.
    *Tag: *

  • Admin Page Enhancements:
    • “Admin pages have been modified to work better on smaller screen sizes” clearly states improvements in responsiveness. Consider confirming if any additional browser or resolution details should be mentioned for clarity.
    *Tag: *

  • GDPR Text Hyperlink Support:
    • “The GDPR field agreement text now supports links” is straightforward; verify that the documentation (e.g. in the updated Readme) reflects how and where this new behavior is configured.
    *Tag: *

  • Currency Calculations Fixes:
    • The entries regarding currency values need slight rephrasing for clarity. For example, instead of “using thousand separators that are not a decimal or a comma,” consider: “using non-standard thousand separators.”
    *Tag: *

  • Deprecated Message Fix:
    • The bullet “A Passing null to parameter deprecated message … has been fixed” could benefit from rewording for grammatical consistency (e.g. “The ‘Passing null to parameter…’ deprecated message no longer appears.”).
    *Tag: *

  • Serialized Data & CSS Variable Validation:
    • The points on additional validation to prevent issues with invalid serialized data and to validate CSS variables are comprehensive. It might be worthwhile to break the long sentence describing the contact form preview update into two sentences for improved readability.
    *Tag: *

Please also ensure that the changes highlighted here are cross-referenced with any updates made to the Readme file (as per the PR objective “Update readme for v6.20”) so that version information and feature descriptions remain consistent across documentation.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0dfdb6f and d0a5e82.

📒 Files selected for processing (2)
  • changelog.txt (1 hunks)
  • readme.txt (3 hunks)
🧰 Additional context used
🪛 LanguageTool
readme.txt

[grammar] ~380-~380: Use “a thousand”, or use a number before ‘thousand’.
Context: ...ency formatted values would break using thousand separators that are not a decimal or a ...

(NODT_DOZEN)


[uncategorized] ~384-~384: Possible missing comma found.
Context: ...conflict with WPML would cause querying issues resulting in empty results when checkin...

(AI_HYDRA_LEO_MISSING_COMMA)


[style] ~387-~387: This adverb was used twice in the sentence. Consider removing one of them or replacing them with a synonym.
Context: ...lled automatically on every site is now automatically blocked from anyone without access to v...

(ADVERB_REPETITION_PREMIUM)

⏰ Context from checks skipped due to timeout of 90000ms (6)
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: Cypress
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: Cypress
  • GitHub Check: PHP 7.4 tests in WP trunk
🔇 Additional comments (2)
readme.txt (2)

8-8: Stable Tag Updated to 6.20
The stable tag has been correctly updated from 6.19 to 6.20, which clearly indicates the new release version as per the PR objectives.


413-415: Upgrade Notice Section Reviewed
The Upgrade Notice section is clear and concise, effectively communicating the security fix in version 6.20 and urging an immediate upgrade.

@Crabcyborg Crabcyborg merged commit f8f5e53 into master Apr 8, 2025
32 of 34 checks passed
@Crabcyborg Crabcyborg deleted the update_readme_6.20 branch April 8, 2025 15:45
@coderabbitai coderabbitai Bot mentioned this pull request Apr 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant