Skip to content

Mark single sign-on as available from v1.5.0 - #9

Merged
mrtncode merged 1 commit into
openinvento:mainfrom
tioan:docs/sso-version-note
Nov 4, 2026
Merged

mrtncode merged 1 commit into
openinvento:mainfrom
tioan:docs/sso-version-note

Conversation

@tioan

@tioan tioan commented Nov 1, 2026 •

Copy link
Copy Markdown
Contributor

Description of Changes

The single sign-on docs from #7 are live, but single sign-on is not released yet (v1.4.1 is the latest release). This adds a note that it is available from v1.5.0:

  • an info box at the top of setup-installation/single-sign-on.mdx and security/oidc-security.mdx
  • "Available from v1.5.0." on the OIDC_*, DISABLE_LOCAL_LOGIN and LOCAL_LOGIN_USERS rows of setup-installation/configuration.mdx, and on the APP_URLS fallback

Please adjust the version if the release with single sign-on gets another number. The notes stay useful after the release for anyone on an older version. #10 / #11 suggests versioning the docs as the longer-term fix; this PR works with or without it.

npm run build passes.

Summary by CodeRabbit

  • Documentation
    • Clarified that OpenID Connect single sign-on and related configuration settings are available starting with OpenInvento v1.5.0, and are not included in v1.4.1 or earlier.
    • Added version availability information to the APP_URLS best-practice guidance.

@github-actions

github-actions Bot commented Nov 1, 2026

Copy link
Copy Markdown

All contributors have signed the Contributor License Agreement ✅.
Posted by the CLA Assistant Lite bot.

@coderabbitai

coderabbitai Bot commented Nov 1, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 7c3cceab-170c-43d9-a4bd-b1e8001cec56
Commits

Reviewing files that changed from the base of the PR and between 51ba8d0 and 7fea931.

Files selected for processing: 3
  • docs/security/oidc-security.mdx
  • docs/setup-installation/configuration.mdx
  • docs/setup-installation/single-sign-on.mdx

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 7 remain after this review.

Walkthrough

The documentation now identifies v1.5.0 as the first OpenInvento release with OIDC single sign-on and local-login settings. It also marks the APP_URLS best practice as available from v1.5.0.

Changes: Version availability documentation

Layer / File(s) Summary
Add v1.5.0 availability notices
docs/setup-installation/configuration.mdx, docs/setup-installation/single-sign-on.mdx, docs/security/oidc-security.mdx
The environment-variable entries and APP_URLS best practice are marked as available from v1.5.0. The setup and security pages state that single sign-on is not included in v1.4.1 or earlier.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

  • openinvento/docs#7: Adds the single sign-on documentation and OIDC configuration entries that this PR marks as available from v1.5.0.

Suggested reviewers: mrtncode

Merge Risk: Minimal · up to 7fea9

The documentation-only change is consistent across the affected pages and presents no identified merge-blocking risk.

Architecture risk: Low · up to 7fea9

The change affects 1 system.

Changed systems: docs

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — docs (service) was modified; 3 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in docs/security/oidc-security.mdx: Added an information callout specifying the OpenID Connect availability versions: v1.5.0 and later, but not v1.4.1 or earlier.
  • observed — Modified behavior in docs/setup-installation/configuration.mdx: Added “Available from v1.5.0” to the descriptions of the seven OIDC and local-login environment-variable entries; their documented defaults and settings are unchanged.
  • observed — Modified behavior in docs/setup-installation/configuration.mdx: Added “(from v1.5.0)” to the APP_URLS best-practice label; the documented fallback and SSO host behavior are unchanged.
  • observed — Modified behavior in docs/setup-installation/single-sign-on.mdx: Added an information notice specifying that single sign-on is available in OpenInvento v1.5.0 and later, but not in v1.4.1 or earlier.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title "Mark single sign-on as available from v1.5.0" matches the main change. The PR adds notes stating that single sign-on is available from v1.5.0 across the SSO, OIDC security, and configuratio…
Description check Passed The description states the problem, which is that single sign-on docs are live but the feature is not released (v1.4.1 is latest). It lists each changed file and row, notes the version may change, and…
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
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.
Full details: Title check

Explanation

The title "Mark single sign-on as available from v1.5.0" matches the main change. The PR adds notes stating that single sign-on is available from v1.5.0 across the SSO, OIDC security, and configuration docs. The title is specific and concise, and it names the version and feature.

Full details: Description check

Explanation

The description states the problem, which is that single sign-on docs are live but the feature is not released (v1.4.1 is latest). It lists each changed file and row, notes the version may change, and reports that the build passes. It follows the repository template's intent of briefly describing the changes, though it does not use the exact template heading format beyond the "Description of Changes" section. The required information is present.

Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (3 skipped: 3 unsupported.)

Finishing Touches
Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

@mrtncode
mrtncode merged commit 61fcd35 into openinvento:main Nov 4, 2026
2 checks passed
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 4, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants