Skip to content

Add docs for IAM CTL dry-run mode#6242

Open
RovinKYK wants to merge 4 commits into
wso2:masterfrom
RovinKYK:master
Open

Add docs for IAM CTL dry-run mode#6242
RovinKYK wants to merge 4 commits into
wso2:masterfrom
RovinKYK:master

Conversation

@RovinKYK

@RovinKYK RovinKYK commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Purpose

This PR introduces docs related to the IAM CTL dry-run mode.

Related to: wso2/product-is#27997

Related PRs

Test environment

Security checks

Copilot AI review requested due to automatic review settings July 5, 2026 09:23

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@RovinKYK, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 52 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 1395804c-a19d-422f-b2f7-789cbc8e97fb

📥 Commits

Reviewing files that changed from the base of the PR and between 41a8228 and af7666d.

📒 Files selected for processing (2)
  • en/identity-server/5.11.0/docs/setup/promote-configurations.md
  • en/includes/deploy/ctl-tool/dryRun-mode.md
📝 Walkthrough

Walkthrough

This PR adds shared dry-run mode documentation, includes it in multiple Asgardeo and Identity Server deployment guides, and adds a standalone dry-run section to the 5.11.0 setup guide.

Changes

Dry-run mode documentation

Layer / File(s) Summary
Shared dry-run mode content
en/includes/deploy/ctl-tool/dryRun-mode.md
Adds documentation for --dryRun/-d behavior with importAll/exportAll, skipped mutating operations, logging format, deletion handling, and summary count changes.
Wire dry-run include into deployment guides
en/asgardeo/docs/guides/your-asgardeo/manage-environments/promote-configurations.md, en/identity-server/7.0.0/docs/deploy/promote-configurations.md, en/identity-server/7.1.0/docs/deploy/promote-configurations.md, en/identity-server/7.2.0/docs/deploy/promote-configurations.md, en/identity-server/7.3.0/docs/deploy/promote-configurations.md, en/identity-server/next/docs/deploy/promote-configurations.md
Adds an include directive for the shared dryRun-mode.md snippet into each version-specific promote-configurations guide.
5.11.0 dry-run section
en/identity-server/5.11.0/docs/setup/promote-configurations.md
Adds a directly written "Dry-run mode" section describing the same --dryRun/-d behavior for this older documentation format.

Suggested labels: Team/Identity Server Core

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding IAM CTL dry-run mode docs.
Description check ✅ Passed The description follows the template and includes a clear purpose and issue reference, with the remaining sections present but not filled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@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

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/identity-server/5.11.0/docs/setup/promote-configurations.md`:
- Around line 195-205: The command examples under the import/export section use
bold labels instead of real subheadings, which triggers the MD036 markdown lint
rule and weakens the document structure. Update the section in
promote-configurations.md by replacing the `importAll` and `exportAll` bold
markers with proper heading syntax, keeping the command blocks under clear
subheadings so the section remains readable and lint-clean.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 03e039e6-85e8-43aa-bc81-aec34c7064a7

📥 Commits

Reviewing files that changed from the base of the PR and between 3637dc9 and cfe9974.

📒 Files selected for processing (8)
  • en/asgardeo/docs/guides/your-asgardeo/manage-environments/promote-configurations.md
  • en/identity-server/5.11.0/docs/setup/promote-configurations.md
  • en/identity-server/7.0.0/docs/deploy/promote-configurations.md
  • en/identity-server/7.1.0/docs/deploy/promote-configurations.md
  • en/identity-server/7.2.0/docs/deploy/promote-configurations.md
  • en/identity-server/7.3.0/docs/deploy/promote-configurations.md
  • en/identity-server/next/docs/deploy/promote-configurations.md
  • en/includes/deploy/ctl-tool/dryRun-mode.md

Comment thread en/identity-server/5.11.0/docs/setup/promote-configurations.md Outdated
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.

3 participants