Skip to content

MTA-6522 Added developer preview admonition for Python and nodejs providers#329

Merged
Pkylas007 merged 4 commits intomainfrom
mta-6522-python-nodejs-dev-preview
Mar 25, 2026
Merged

MTA-6522 Added developer preview admonition for Python and nodejs providers#329
Pkylas007 merged 4 commits intomainfrom
mta-6522-python-nodejs-dev-preview

Conversation

@Pkylas007
Copy link
Copy Markdown
Collaborator

@Pkylas007 Pkylas007 commented Mar 12, 2026

JIRA

Version

  • 8.1.0

Preview

3.1. Provider condition Developer Preview Note

Summary by CodeRabbit

  • Documentation
    • Replaced dotnet provider references with C# across YAML provider condition docs and updated Developer Preview wording to reference csharp, python, and nodejs providers.
    • Added csharp.referenced capability with expanded examples covering CLASS, ALL, METHOD, FIELD and namespace/import usage; renamed scoping field from namespace to location and clarified ALL semantics.
    • Updated provider/capability tables, cross-references, example patterns, and minor formatting for clearer C# guidance.

…viders

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 90da1332-006b-4f5f-b3c7-7b56ac2ca088

📥 Commits

Reviewing files that changed from the base of the PR and between 9331747 and 603a7ce.

📒 Files selected for processing (1)
  • docs/topics/rules-development/yaml-provider-conditions.adoc
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/topics/rules-development/yaml-provider-conditions.adoc

📝 Walkthrough

Walkthrough

Replaced dotnet provider references with C#, added a new csharp.referenced capability with multiple location examples (CLASS, ALL, METHOD, FIELD, namespace/import), renamed scoping field namespacelocation, updated Developer Preview label to include csharp, python, and nodejs providers, and adjusted related examples, xrefs, patterns, and table formatting.

Changes

Cohort / File(s) Summary
YAML Provider Documentation
docs/topics/rules-development/yaml-provider-conditions.adoc
Replaced dotnet with C#; added csharp.referenced capability and multiple when: csharp.referenced: ... examples (CLASS, ALL, METHOD, FIELD, namespace/import); renamed namespace field to location and expanded its description; updated Developer Preview text to list csharp, python, and nodejs providers; adjusted regex/example patterns and minor table formatting and xref targets.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I hop through lines from old to new,
Dotnet to C# — a bright debut,
I plant examples in CLASS and FIELD,
LOCATION renamed, clarity revealed,
A tiny hop, documentation renewed.

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title only references adding a developer preview admonition for Python and Node.js, but the changeset also replaces dotnet with C#, adds csharp.referenced capability documentation, and updates multiple tables and examples. Update the title to reflect the primary change: replace 'dotnet' with 'C#' in provider documentation and add developer preview admonitions for multiple providers. For example: 'Replace dotnet provider with C# and add developer preview admonitions for Python, Node.js, and C# providers'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mta-6522-python-nodejs-dev-preview

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@Pkylas007 Pkylas007 requested a review from mpershina March 12, 2026 06:15
@Pkylas007
Copy link
Copy Markdown
Collaborator Author

@mpershina Hello there! Please could you check if the Developer Preview looks alright? Many thanks!

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: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/rules-development/yaml-provider-conditions.adoc`:
- Line 457: The cross-reference and provider naming are inconsistent: the xref
target `yaml-dotnet-provider_rules-prov-cond` and the actual anchor
`yaml-dotnet-provider_{context}` in yaml-provider-conditions.adoc clash with the
displayed "csharp" text and the target file yaml-dotnet-provider.adoc still uses
"dotnet"; fix by either (A) renaming the provider to "csharp" across the target
file and anchors—update yaml-dotnet-provider.adoc (title, example identifiers
like dotnet.referenced, internal anchors, and file name/IDs to use csharp) and
change the anchor to match `yaml-csharp-provider_rules-prov-cond`, or (B) keep
"dotnet" everywhere and change the xref on line 457 to reference the correct
existing anchor (e.g., `yaml-dotnet-provider_{context}` or
`yaml-dotnet-provider_rules-prov-cond`) and revert any "csharp" display text
back to "dotnet"; ensure all internal anchors, xref IDs, title, and example
identifiers (e.g., dotnet.referenced / csharp.referenced) are consistent after
the change.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4c75cce4-9d34-43ba-a8aa-c9143773803a

📥 Commits

Reviewing files that changed from the base of the PR and between 7a9a933 and f2a92ee.

📒 Files selected for processing (1)
  • docs/topics/rules-development/yaml-provider-conditions.adoc

Comment thread docs/topics/rules-development/yaml-provider-conditions.adoc Outdated
Comment thread docs/topics/rules-development/yaml-provider-conditions.adoc
Comment thread docs/topics/rules-development/yaml-provider-conditions.adoc Outdated
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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: 1

♻️ Duplicate comments (1)
docs/topics/rules-development/yaml-provider-conditions.adoc (1)

467-513: ⚠️ Potential issue | 🟡 Minor

Add block continuations so this table cell renders correctly.

The new list/examples block is still missing + continuations between each bullet and its source block, so the table cell rendering breaks in preview.

Proposed fix
  * Type reference including classes, interfaces and structure types (struct). For example: 
-
+ +
   [subs="+quotes"]
   ----
   when:
     csharp.referenced:
       location: CLASS
       pattern: System.Web.Http.ApiController.*
   ----
-
+ +
   [subs="+quotes"]
   ----
   when:
     csharp.referenced:
       location: ALL
       pattern: "System.Console.Print*"
   ----

  * Method calls and definitions. For example:
-
+ +
   [subs="+quotes"]
   ----
   when:
     csharp.referenced:
       location: METHOD
       pattern: "*.AppDomain.Unload"
   ----

  * Field usages and declaration. For example:
-
+ +
   [subs="+quotes"]
   ----
   when:
     csharp.referenced:
       location: FIELD
       pattern: "DotNetOpenAuth.AspNet.AuthenticationResult.Provider"
   ----

  * Namespace imports and usages. For example: 
- 
+ +
   [subs="+quotes"]
   ----
   when:
     csharp.referenced:
       location: ALL
       pattern: "System.Windows.Forms"
   ----
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/topics/rules-development/yaml-provider-conditions.adoc` around lines 467
- 513, The table cell's example blocks need AsciiDoc block continuations so each
source block attaches to its preceding bullet: insert a single line containing a
plus sign (+) between each bullet line and the following fenced source block for
all four examples (the Type reference example with when: csharp.referenced /
pattern System.Web.Http.ApiController.*, the pattern "System.Console.Print*"
example, the Method calls example with pattern "*.AppDomain.Unload", the Field
usages example with pattern
"DotNetOpenAuth.AspNet.AuthenticationResult.Provider", and the Namespace imports
example with pattern "System.Windows.Forms") so each bullet correctly continues
into its subsequent [subs="+quotes"] ---- block.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/rules-development/yaml-provider-conditions.adoc`:
- Around line 32-36: The preview warning incorrectly broadens scope by including
"Csharp" in the {FeatureName} attribute; update the attribute definition that
sets :FeatureName: so it lists only "Python and Nodejs providers" (remove
"Csharp") or, if C# truly is preview-only, update the PR description to state
that and keep "Csharp" but ensure the admonition text and heading consistently
reflect C# as Developer Preview; target the line that defines :FeatureName: and
the {FeatureName} usage so the admonition matches the intended preview scope.

---

Duplicate comments:
In `@docs/topics/rules-development/yaml-provider-conditions.adoc`:
- Around line 467-513: The table cell's example blocks need AsciiDoc block
continuations so each source block attaches to its preceding bullet: insert a
single line containing a plus sign (+) between each bullet line and the
following fenced source block for all four examples (the Type reference example
with when: csharp.referenced / pattern System.Web.Http.ApiController.*, the
pattern "System.Console.Print*" example, the Method calls example with pattern
"*.AppDomain.Unload", the Field usages example with pattern
"DotNetOpenAuth.AspNet.AuthenticationResult.Provider", and the Namespace imports
example with pattern "System.Windows.Forms") so each bullet correctly continues
into its subsequent [subs="+quotes"] ---- block.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b49624d9-2ef6-4c55-bfe9-9a9b8222bcef

📥 Commits

Reviewing files that changed from the base of the PR and between f2a92ee and 1035de1.

📒 Files selected for processing (1)
  • docs/topics/rules-development/yaml-provider-conditions.adoc

Comment thread docs/topics/rules-development/yaml-provider-conditions.adoc Outdated
@Pkylas007 Pkylas007 requested a review from dymurray March 16, 2026 06:16
Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/topics/rules-development/yaml-provider-conditions.adoc`:
- Around line 30-38: The FeatureName variable currently includes "C#, Python,
and Nodejs providers" but the PR description only mentions "Python and Node.js
providers"; either remove "C#" from the FeatureName declaration so it reads
"Python and Node.js providers" (update occurrences where FeatureName is used) or
update the PR description to explicitly include C# as part of the change (ensure
exact casing "C#" and "Node.js" are consistent). Locate the FeatureName symbol
in the document and make the change so the FeatureName value and PR
description/scope are consistent.
- Line 457: The cross-reference anchor IDs are wrong: change occurrences like
xref:yaml-dotnet-provider_rules-prov-cond[C#] to xref:yaml-dotnet-provider[C#]
to match the actual anchor (yaml-dotnet-provider_{context}); likewise update the
other provider xrefs that use the *_rules-prov-cond form (e.g.,
yaml-java-provider_rules-prov-cond, yaml-builtin-provider_rules-prov-cond,
yaml-go-provider_rules-prov-cond) to their correct anchors (yaml-java-provider,
yaml-builtin-provider, yaml-go-provider) so each xref matches the anchor names
in yaml-dotnet-provider.adoc.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 1baeec2e-2d83-4a6c-9157-20a615e72742

📥 Commits

Reviewing files that changed from the base of the PR and between 1035de1 and 9331747.

📒 Files selected for processing (1)
  • docs/topics/rules-development/yaml-provider-conditions.adoc

Comment thread docs/topics/rules-development/yaml-provider-conditions.adoc
Comment thread docs/topics/rules-development/yaml-provider-conditions.adoc
@sshveta
Copy link
Copy Markdown
Collaborator

sshveta commented Mar 19, 2026

@mguetta1 can you review as well please

Copy link
Copy Markdown
Contributor

@mguetta1 mguetta1 left a comment

Choose a reason for hiding this comment

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

LGTM

:FeatureName: Dotnet provider
* `C#`

:FeatureName: C#, Python, and Nodejs providers
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

please check Nodejs.

I just think if we use Python then we might need to use Node.js

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I have changed it to the exact name of the providers than the programming language itself, thanks! :)

Signed-off-by: Prabha Kylasamiyer Sundara Rajan <pkylasam@pkylasam-thinkpadp16vgen1.bengluru.csb>
@Pkylas007 Pkylas007 merged commit 2f0228f into main Mar 25, 2026
2 checks passed
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.

6 participants