Skip to content

Conversation

@dmitryuk
Copy link
Owner

@dmitryuk dmitryuk commented Aug 11, 2025

Summary by CodeRabbit

  • New Features

    • Added configurable visibility toggles: Hide Internal, Hide Try It, Hide Try It Panel, Hide Schemas, Hide Export.
    • Link (URL) is now required; its value can be shown in the placeholder.
    • Updated on-screen labels and descriptions for the macro and its parameters.
  • Refactor

    • Macro renamed to “Previewer Workspace” in the Confluence UI.
  • Chores

    • Version bumped to 1.3.0.

@coderabbitai
Copy link

coderabbitai bot commented Aug 11, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This change updates the plugin version, renames and reconfigures the macro in the Atlassian descriptor, adds new boolean parameters, adjusts i18n contexts and properties, and updates the Java macro to emit an elements-api tag with additional attributes and defaulted boolean handling.

Changes

Cohort / File(s) Summary of Changes
Version bump
pom.xml
Artifact version updated from 1.2.1 to 1.3.0.
Macro implementation
src/main/java/.../StoplightElementsPreviewer.java
Renamed execute parameter to parameters; builds elements-api tag using link and new boolean attributes (hideInternal, hideTryIt, hideTryItPanel, hideSchemas, hideExport); added helper getBoolean with default "false".
Plugin descriptor and macro config
src/main/resources/atlassian-plugin.xml
i18n and web-resource context renamed to previewer-context; styles.css includes content-type; macro renamed to previewer-workspace with key previewer-workspace; macro description removed; added parameters: link (required), and booleans (hideInternal, hideTryIt, hideTryItPanel, hideSchemas, hideExport) with defaults.
i18n properties migration
src/main/resources/WebVideo.properties, src/main/resources/previewer-context.properties
Removed StopLightElements-related entries from WebVideo.properties; added new previewer-context.properties defining labels/descriptions for workspace and parameters (link and boolean flags).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Confluence
    participant Macro as StoplightElementsPreviewer
    User->>Confluence: Insert "previewer-workspace" macro with parameters
    Confluence->>Macro: execute(parameters, body, context)
    Macro->>Macro: Read link and boolean flags (default "false")
    Macro-->>Confluence: Return <elements-api ...> tag with attributes
    Confluence-->>User: Render Stoplight Elements preview
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

I thump my paws: new flags in tow,
A workspace macro, neat in row.
From WebVideo to previewer bright,
The elements tag now set just right.
Version hops to one-three-oh—
I nibble docs and watch it go! 🥕✨


📜 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 6c8bc1f and 414fec7.

📒 Files selected for processing (5)
  • pom.xml (1 hunks)
  • src/main/java/com/validate_lab/confluence/stoplightelements_previewer/macro/StoplightElementsPreviewer.java (2 hunks)
  • src/main/resources/WebVideo.properties (0 hunks)
  • src/main/resources/atlassian-plugin.xml (1 hunks)
  • src/main/resources/previewer-context.properties (1 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix-colors

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

Support

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

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 generate unit tests to generate unit tests for 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.

@dmitryuk dmitryuk merged commit f00a2ff into master Aug 11, 2025
@dmitryuk dmitryuk deleted the fix-colors branch August 13, 2025 05:14
@coderabbitai coderabbitai bot mentioned this pull request Aug 22, 2025
@coderabbitai coderabbitai bot mentioned this pull request Sep 8, 2025
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