Amended the 7.3 release note to fix wordings and some incorrect info#6052
Conversation
📝 WalkthroughWalkthroughDocumentation update to the Identity Server release notes with multiple wording refinements and terminology standardization across sections. Substantially rewrites the selectable token issuer section to emphasize console-driven issuer selection and organizational identity provider capabilities. Updates link references and webhook event formatting. Changes
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@en/identity-server/next/docs/get-started/about-this-release.md`:
- Line 197: Split the long sentence that describes the Pre-Issue ID Token Action
into two concise sentences: first state that WSO2 Identity Server supports the
Pre-Issue ID Token Action (a pre-flow extension), and then add a second short
sentence explaining that you can register an external HTTPS service endpoint
which the server calls synchronously during ID token issuance; update the
sentence containing the phrases "Pre-Issue ID Token Action" and "register an
external HTTPS service endpoint" accordingly to keep each sentence short and
plain.
- Line 205: The long sentence that starts "WSO2 Identity Server now extends
support for managing and promoting configuration data using the IAM-CTL tool..."
should be split into two short, plain-language sentences to improve
scannability; replace that single sentence with something like: "WSO2 Identity
Server now supports managing and promoting configuration data using the IAM-CTL
tool. IAM-CTL is a command-line utility for environment promotion, CI/CD
automation, and configuration backups." Ensure the paragraph contains the phrase
"IAM-CTL" and keeps both sentences concise.
- Line 119: The long sentence "From WSO2 Identity Server 7.3.0, you can
configure rules for user operations, such as adding a user or creating a role,
to control whether an approval workflow triggers when the operation occurs."
should be split into two shorter sentences for readability; update the sentence
in about-this-release.md so the first sentence introduces that since 7.3.0
admins can configure rules for user operations and the second sentence lists
examples and explains that those rules control whether an approval workflow
triggers (e.g., "From WSO2 Identity Server 7.3.0, you can configure rules for
user operations. For example, adding a user or creating a role can be controlled
to determine whether an approval workflow is triggered.").
- Line 309: Replace the long sentence starting "Administrators can set the
maximum number of times..." by changing "maximum" to "max" and splitting into
two shorter sentences: first say "Administrators can set the max number of times
a user can attempt to verify a one‑time password or request a new one." and then
a second sentence "These limits help mitigate brute‑force attacks and reduce
unnecessary SMS or email delivery costs and apply across both API‑based and
redirect‑based authentication flows." Update the sentence in the
about-this-release paragraph accordingly.
🪄 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: ba3c333f-725b-41d7-b26c-6a70d884e889
📒 Files selected for processing (1)
en/identity-server/next/docs/get-started/about-this-release.md
| ### Rule-based workflow engagement | ||
|
|
||
| From WSO2 Identity Server 7.3.0, you can configure rules for user operations, such as adding a user or creating a role, to control whether an approval workflow should be triggered when the operation occurs. | ||
| From WSO2 Identity Server 7.3.0, you can configure rules for user operations, such as adding a user or creating a role, to control whether an approval workflow triggers when the operation occurs. |
There was a problem hiding this comment.
Split this sentence to satisfy length/style checks.
Line 119 is too long and triggers Vale. Break it into two shorter sentences for readability.
✍️ Suggested edit
-From WSO2 Identity Server 7.3.0, you can configure rules for user operations, such as adding a user or creating a role, to control whether an approval workflow triggers when the operation occurs.
+From WSO2 Identity Server 7.3.0, you can configure rules for user operations such as adding a user or creating a role.
+These rules control whether an approval workflow triggers when the operation occurs.As per coding guidelines, "Use plain language and short sentences."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| From WSO2 Identity Server 7.3.0, you can configure rules for user operations, such as adding a user or creating a role, to control whether an approval workflow triggers when the operation occurs. | |
| From WSO2 Identity Server 7.3.0, you can configure rules for user operations such as adding a user or creating a role. | |
| These rules control whether an approval workflow triggers when the operation occurs. |
🧰 Tools
🪛 GitHub Actions: Vale Lint (Changed Markdown Only)
[warning] 119-119: [WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
🪛 GitHub Check: Vale style check
[warning] 119-119:
[vale] reported by reviewdog 🐶
[WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
Raw Output:
{"message": "[WSO2-IAM.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "en/identity-server/next/docs/get-started/about-this-release.md", "range": {"start": {"line": 119, "column": 1}}}, "severity": "INFO"}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/identity-server/next/docs/get-started/about-this-release.md` at line 119,
The long sentence "From WSO2 Identity Server 7.3.0, you can configure rules for
user operations, such as adding a user or creating a role, to control whether an
approval workflow triggers when the operation occurs." should be split into two
shorter sentences for readability; update the sentence in about-this-release.md
so the first sentence introduces that since 7.3.0 admins can configure rules for
user operations and the second sentence lists examples and explains that those
rules control whether an approval workflow triggers (e.g., "From WSO2 Identity
Server 7.3.0, you can configure rules for user operations. For example, adding a
user or creating a role can be controlled to determine whether an approval
workflow is triggered.").
| ### Pre-issue ID token action | ||
|
|
||
| WSO2 Identity Server now supports the Pre-Issue ID Token Action, a pre-flow extension that allows you to execute custom logic just before an OIDC ID token is issued. You can register an external HTTPS service endpoint that WSO2 Identity Server calls synchronously during the ID token issuance flow. | ||
| WSO2 Identity Server now supports the Pre-Issue ID Token Action, a pre-flow extension that allows you to execute custom logic just before WSO2 Identity Server issues an OIDC ID token. You can register an external HTTPS service endpoint that WSO2 Identity Server calls synchronously during the ID token issuance flow. |
There was a problem hiding this comment.
Shorten the pre-issue action description sentence.
Line 197 exceeds the sentence-length rule. Split it into concise statements.
✍️ Suggested edit
-WSO2 Identity Server now supports the Pre-Issue ID Token Action, a pre-flow extension that allows you to execute custom logic just before WSO2 Identity Server issues an OIDC ID token. You can register an external HTTPS service endpoint that WSO2 Identity Server calls synchronously during the ID token issuance flow.
+WSO2 Identity Server now supports the Pre-Issue ID Token Action.
+This pre-flow extension lets you run custom logic just before WSO2 Identity Server issues an OIDC ID token.
+You can register an external HTTPS service endpoint that WSO2 Identity Server calls synchronously during the ID token issuance flow.As per coding guidelines, "Use plain language and short sentences."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| WSO2 Identity Server now supports the Pre-Issue ID Token Action, a pre-flow extension that allows you to execute custom logic just before WSO2 Identity Server issues an OIDC ID token. You can register an external HTTPS service endpoint that WSO2 Identity Server calls synchronously during the ID token issuance flow. | |
| WSO2 Identity Server now supports the Pre-Issue ID Token Action. | |
| This pre-flow extension lets you run custom logic just before WSO2 Identity Server issues an OIDC ID token. | |
| You can register an external HTTPS service endpoint that WSO2 Identity Server calls synchronously during the ID token issuance flow. |
🧰 Tools
🪛 GitHub Actions: Vale Lint (Changed Markdown Only)
[warning] 197-197: [WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
🪛 GitHub Check: Vale style check
[warning] 197-197:
[vale] reported by reviewdog 🐶
[WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
Raw Output:
{"message": "[WSO2-IAM.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "en/identity-server/next/docs/get-started/about-this-release.md", "range": {"start": {"line": 197, "column": 1}}}, "severity": "INFO"}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/identity-server/next/docs/get-started/about-this-release.md` at line 197,
Split the long sentence that describes the Pre-Issue ID Token Action into two
concise sentences: first state that WSO2 Identity Server supports the Pre-Issue
ID Token Action (a pre-flow extension), and then add a second short sentence
explaining that you can register an external HTTPS service endpoint which the
server calls synchronously during ID token issuance; update the sentence
containing the phrases "Pre-Issue ID Token Action" and "register an external
HTTPS service endpoint" accordingly to keep each sentence short and plain.
| ### Enhanced IAM-CTL support for configuration promotion | ||
|
|
||
| WSO2 Identity Server now provides enhanced support for managing and promoting configuration data using the IAM-CTL tool, a command-line utility that acts as a bridge for environment promotion, CI/CD automation, and configuration backups. | ||
| WSO2 Identity Server now extends support for managing and promoting configuration data using the IAM-CTL tool, a command-line utility for environment promotion, CI/CD automation, and configuration backups. |
There was a problem hiding this comment.
Reduce sentence length in IAM-CTL paragraph.
Line 205 is over the preferred sentence length. Split it to keep the release note scannable.
✍️ Suggested edit
-WSO2 Identity Server now extends support for managing and promoting configuration data using the IAM-CTL tool, a command-line utility for environment promotion, CI/CD automation, and configuration backups.
+WSO2 Identity Server now extends support for managing and promoting configuration data using the IAM-CTL tool.
+IAM-CTL is a command-line utility for environment promotion, CI/CD automation, and configuration backups.As per coding guidelines, "Use plain language and short sentences."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| WSO2 Identity Server now extends support for managing and promoting configuration data using the IAM-CTL tool, a command-line utility for environment promotion, CI/CD automation, and configuration backups. | |
| WSO2 Identity Server now extends support for managing and promoting configuration data using the IAM-CTL tool. | |
| IAM-CTL is a command-line utility for environment promotion, CI/CD automation, and configuration backups. |
🧰 Tools
🪛 GitHub Actions: Vale Lint (Changed Markdown Only)
[warning] 205-205: [WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
🪛 GitHub Check: Vale style check
[warning] 205-205:
[vale] reported by reviewdog 🐶
[WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
Raw Output:
{"message": "[WSO2-IAM.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "en/identity-server/next/docs/get-started/about-this-release.md", "range": {"start": {"line": 205, "column": 1}}}, "severity": "INFO"}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/identity-server/next/docs/get-started/about-this-release.md` at line 205,
The long sentence that starts "WSO2 Identity Server now extends support for
managing and promoting configuration data using the IAM-CTL tool..." should be
split into two short, plain-language sentences to improve scannability; replace
that single sentence with something like: "WSO2 Identity Server now supports
managing and promoting configuration data using the IAM-CTL tool. IAM-CTL is a
command-line utility for environment promotion, CI/CD automation, and
configuration backups." Ensure the paragraph contains the phrase "IAM-CTL" and
keeps both sentences concise.
| WSO2 Identity Server now supports configuring limits on OTP retry and resend attempts within a single authentication session using adaptive authentication scripts. This helps prevent misuse while preserving a consistent experience for legitimate users. | ||
|
|
||
| Administrators can define the upper limit on the number of times a user can attempt to verify a one-time password or request a new one, helping to mitigate brute-force attacks and reduce unnecessary SMS or email delivery costs. These limits apply across both API-based and redirect-based authentication flows. | ||
| Administrators can set the maximum number of times a user can attempt to verify a one-time password or request a new one, helping to mitigate brute-force attacks and reduce unnecessary SMS or email delivery costs. These limits apply across both API-based and redirect-based authentication flows. |
There was a problem hiding this comment.
Replace “maximum” and split this long sentence.
Line 309 triggers both TooWordy and SentenceLength. Replace “maximum” with “max” and split the sentence.
✍️ Suggested edit
-Administrators can set the maximum number of times a user can attempt to verify a one-time password or request a new one, helping to mitigate brute-force attacks and reduce unnecessary SMS or email delivery costs. These limits apply across both API-based and redirect-based authentication flows.
+Administrators can set the max number of verification and resend attempts for a one-time password.
+This helps mitigate brute-force attacks and reduce unnecessary SMS or email delivery costs.
+These limits apply to both API-based and redirect-based authentication flows.As per coding guidelines, "Use plain language and short sentences."
🧰 Tools
🪛 GitHub Actions: Vale Lint (Changed Markdown Only)
[warning] 309-309: [WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
[warning] 309-309: [WSO2-IAM.TooWordy] 'maximum' is too wordy.
🪛 GitHub Check: Vale style check
[warning] 309-309:
[vale] reported by reviewdog 🐶
[WSO2-IAM.TooWordy] 'maximum' is too wordy.
Raw Output:
{"message": "[WSO2-IAM.TooWordy] 'maximum' is too wordy.", "location": {"path": "en/identity-server/next/docs/get-started/about-this-release.md", "range": {"start": {"line": 309, "column": 28}}}, "severity": "WARNING"}
[warning] 309-309:
[vale] reported by reviewdog 🐶
[WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
Raw Output:
{"message": "[WSO2-IAM.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "en/identity-server/next/docs/get-started/about-this-release.md", "range": {"start": {"line": 309, "column": 1}}}, "severity": "INFO"}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/identity-server/next/docs/get-started/about-this-release.md` at line 309,
Replace the long sentence starting "Administrators can set the maximum number of
times..." by changing "maximum" to "max" and splitting into two shorter
sentences: first say "Administrators can set the max number of times a user can
attempt to verify a one‑time password or request a new one." and then a second
sentence "These limits help mitigate brute‑force attacks and reduce unnecessary
SMS or email delivery costs and apply across both API‑based and redirect‑based
authentication flows." Update the sentence in the about-this-release paragraph
accordingly.
2 participants
Purpose
$subject
Related PRs
Test environment
Security checks