Skip to content

Update README with Sync SAML attributes workflow example#15

Open
oliwolff1 wants to merge 1 commit intomainfrom
oli/update-readme-syncSAMLattributes
Open

Update README with Sync SAML attributes workflow example#15
oliwolff1 wants to merge 1 commit intomainfrom
oli/update-readme-syncSAMLattributes

Conversation

@oliwolff1
Copy link
Copy Markdown

@oliwolff1 oliwolff1 commented Sep 16, 2025

Explain your changes

This change updates the README to reference the workflow example to Sync SAML attributes with Kinde

Checklist

🛟 If you need help, consider asking for advice over in the Kinde community.

Summary by CodeRabbit

  • Documentation
    • Added a README entry highlighting a Sync SAML attributes workflow.
    • Describes how to sync user attributes and groups from a SAML assertion with Kinde and links to the example for easy discovery.
    • No functional or API changes.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Sep 16, 2025

Walkthrough

A single documentation update adds a new bullet to README.md referencing a Sync SAML attributes workflow. No source code or API changes.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added a bullet under “This repo includes examples for” linking to postUserAuthentication/syncAttributesSamlWorkflow.ts, describing syncing user attributes and groups from a SAML assertion with Kinde.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • DaveOrDead

Poem

I twitch my nose at README lines,
A fresh new link, the doc now shines.
Sync SAML tales in tidy prose—
Groups and attrs, mapped like rows.
Hop, hop! I stamp a gentle paw:
Docs updated, no code to draw. 🥕

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Update README with Sync SAML attributes workflow example" accurately and concisely summarizes the primary change in the PR — a documentation-only README update adding a link and description for the Sync SAML attributes workflow — and aligns with the PR description and file-level summary.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch oli/update-readme-syncSAMLattributes

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

  • Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
  • Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.


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.

Copy link
Copy Markdown

@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: 0

🧹 Nitpick comments (1)
README.md (1)

46-46: Optional: make title mirror the description (“…and groups”).
Tiny clarity win and matches what the example does.

Apply this diff:

-- [Sync SAML attributes](https://github.com/kinde-starter-kits/workflow-examples/blob/main/postUserAuthentication/syncAttributesSamlWorkflow.ts) - Sync user attributes and groups from a SAML assertion with Kinde.
+- [Sync SAML attributes and groups](https://github.com/kinde-starter-kits/workflow-examples/blob/main/postUserAuthentication/syncAttributesSamlWorkflow.ts) - Sync user attributes and groups from a SAML assertion with Kinde.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 60edde8 and 2586ad2.

📒 Files selected for processing (1)
  • README.md (1 hunks)
🔇 Additional comments (1)
README.md (1)

46-46: LGTM — README link verified.
README addition is useful and consistent; verified postUserAuthentication/syncAttributesSamlWorkflow.ts exists in the PR branch (OK from verification script).

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.

1 participant