Skip to content

Remove the publish for Action and added relevant field#4243

Merged
Maheshkale447 merged 2 commits into
masterfrom
BugFix/Action_Attribute_DirtyMark
Jun 25, 2025
Merged

Remove the publish for Action and added relevant field#4243
Maheshkale447 merged 2 commits into
masterfrom
BugFix/Action_Attribute_DirtyMark

Conversation

@GokulBothe99

@GokulBothe99 GokulBothe99 commented Jun 24, 2025

Copy link
Copy Markdown
Contributor

Thank you for your contribution.
Before submitting this PR, please make sure:

  • PR description and commit message should describe the changes done in this PR
  • Verify the PR is pointing to correct branch i.e. Release or Beta branch if the code fix is for specific release , else point it to master
  • Latest Code from master or specific release branch is merged to your branch
  • No unwanted\commented\junk code is included
  • No new warning upon build solution
  • Code Summary\Comments are added to my code which explains what my code is doing
  • Existing unit test cases are passed
  • New Unit tests are added for your development
  • Sanity Tests are successfully executed for New and Existing Functionality
  • Verify that changes are compatible with all relevant browsers and platforms.
  • After creating pull request there should not be any conflicts
  • Resolve all Codacy comments
  • Builds and checks are passed before PR is sent for review
  • Resolve code review comments
  • Update the Help Library document to match any feature changes

Summary by CodeRabbit

  • New Features

    • Made the "Active", "Description", and "Run Description" fields editable for users in relevant interfaces.
  • Bug Fixes

    • The "Publish" attribute is now excluded from the attribute list when the "Action" item type is selected, preventing it from appearing in the options for that specific context.

@coderabbitai

coderabbitai Bot commented Jun 24, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

A conditional exclusion was added to remove the "Publish" attribute from editable member names for "Action" items in the Find and Replace page. Additionally, the Act class properties Active, Description, and RunDescription were marked with the [AllowUserToEdit] attribute to enable user editing.

Changes

File(s) Change Summary
Ginger/Ginger/Functionalities/FindAndReplacePage.xaml.cs Added logic to exclude "Publish" from attribute names for "Action" item type in selection change.
Ginger/GingerCoreCommon/Actions/Act.cs Added [AllowUserToEdit] attribute to Active, Description, and RunDescription properties.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FindAndReplacePage
    participant Act

    User->>FindAndReplacePage: Selects main item type ("Action")
    FindAndReplacePage->>FindAndReplacePage: Remove "Publish" from attribute list
    User->>Act: Edits Active/Description/RunDescription properties
    Act-->>User: Properties marked as editable via AllowUserToEdit attribute
Loading

Suggested reviewers

  • Maheshkale447

Poem

In fields of code where carrots grow,
Attributes now let users know—
"Publish" hides when Actions call,
Editable fields now greet us all.
With tweaks so neat and changes bright,
The rabbit hops with code delight! 🥕


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 675aff7 and 2e5c465.

📒 Files selected for processing (1)
  • Ginger/Ginger/Functionalities/FindAndReplacePage.xaml.cs (3 hunks)
🔇 Additional comments (3)
Ginger/Ginger/Functionalities/FindAndReplacePage.xaml.cs (3)

1643-1643: Good practice: Constant definition improves maintainability.

The introduction of the ActionName constant follows good coding practices and addresses the maintainability concern raised in the previous review.


366-366: LGTM! Hardcoded string replaced with constant.

The use of the ActionName constant here improves code maintainability and aligns with the previous review suggestion.


1660-1663: Excellent implementation of conditional attribute exclusion.

The logic correctly removes the "Publish" attribute from the editable member names for "Action" items, which aligns with the PR objectives. The use of nameof(RepositoryItemBase.Publish) is actually superior to a hardcoded string constant as it provides compile-time safety and refactoring support.

Note: This partially addresses the previous review comment's suggestion about using constants. While a constant wasn't created for "Publish", the use of nameof() is a better approach that achieves the same maintainability goals.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate Unit Tests
  • Create PR with Unit Tests
  • Post Copyable Unit Tests in Comment
  • Commit Unit Tests in branch BugFix/Action_Attribute_DirtyMark

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.
    • @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 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai auto-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 or @coderabbitai title 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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d98d9fd and 675aff7.

📒 Files selected for processing (2)
  • Ginger/Ginger/Functionalities/FindAndReplacePage.xaml.cs (1 hunks)
  • Ginger/GingerCoreCommon/Actions/Act.cs (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
Ginger/GingerCoreCommon/Actions/Act.cs (1)
Learnt from: GokulBothe99
PR: Ginger-Automation/Ginger#4226
File: Ginger/GingerCoreCommon/Repository/BusinessFlowLib/BusinessFlow.cs:234-238
Timestamp: 2025-06-13T12:50:36.132Z
Learning: In the Ginger codebase, the `[AllowUserToEdit("<Label>")]` attribute is intentionally supplied with a string that represents the display label (e.g., `"Description"`, `"Active"`), not a default value. Suggestions to remove or change this parameter should be avoided unless the label itself is incorrect.
🔇 Additional comments (3)
Ginger/GingerCoreCommon/Actions/Act.cs (3)

163-165: User-editable flag added correctly to Active

The [AllowUserToEdit("Active")] attribute is consistent with existing conventions (string label equals the display caption). No further action required.


169-171: Description is now exposed for in-place editing – verify downstream tooling

Exposing this field in the UI is desirable, but double-check:

  1. Validation logic that previously assumed the property was read-only.
  2. Any grid / form layouts that need column width or tooltip adjustments.

Otherwise, change looks good.


173-175: Minor inconsistency in display label

[AllowUserToEdit("Run Description")] introduces a space that does not exist in the backing constant (Fields.RunDescription).
If this string is only a UI caption it’s harmless; if it is also used as a key, consider aligning it:

-[AllowUserToEdit("Run Description")]
+[AllowUserToEdit("RunDescription")]

Feel free to ignore if the space is intentional for readability.

⛔ Skipped due to learnings
Learnt from: GokulBothe99
PR: Ginger-Automation/Ginger#4226
File: Ginger/GingerCoreCommon/Repository/BusinessFlowLib/BusinessFlow.cs:234-238
Timestamp: 2025-06-13T12:50:36.132Z
Learning: In the Ginger codebase, the `[AllowUserToEdit("<Label>")]` attribute is intentionally supplied with a string that represents the display label (e.g., `"Description"`, `"Active"`), not a default value. Suggestions to remove or change this parameter should be avoided unless the label itself is incorrect.

Comment thread Ginger/Ginger/Functionalities/FindAndReplacePage.xaml.cs Outdated
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jun 24, 2025
@Maheshkale447
Maheshkale447 merged commit 9ea68c1 into master Jun 25, 2025
20 of 23 checks passed
@Maheshkale447
Maheshkale447 deleted the BugFix/Action_Attribute_DirtyMark branch June 25, 2025 09:35
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