Repository navigation
Mark single sign-on as available from v1.5.0 - #9
Conversation
|
All contributors have signed the Contributor License Agreement ✅. |
|
No actionable comments were generated in the recent review.
|
| 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:
docsArchitecture 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_URLSbest-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: 
5
-
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
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:
setup-installation/single-sign-on.mdxandsecurity/oidc-security.mdxOIDC_*,DISABLE_LOCAL_LOGINandLOCAL_LOGIN_USERSrows ofsetup-installation/configuration.mdx, and on theAPP_URLSfallbackPlease 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 buildpasses.Summary by CodeRabbit
APP_URLSbest-practice guidance.