You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by "cziegeler (via GitHub)" <gi...@apache.org> on 2026/07/16 11:02:59 UTC

[PR] docs: update AGENTS.md and README with project layout, gotchas, and API notes [sling-org-apache-sling-auth-oauth-client]

cziegeler opened a new pull request, #49:
URL: https://github.com/apache/sling-org-apache-sling-auth-oauth-client/pull/49

   Improves both developer-facing docs with clearer guidance and additional detail.
   
   **AGENTS.md**
   - Add `@ProviderType` / experimental API warning callout
   - Mention `OidcAuthCredentials` in the SPI list
   - Add `make sling-run` shortcut to core commands
   - Clarify OIDC metadata-vs-explicit-config constraint
   - Add OIDC logout hardening note (`logoutRedirectAllowedHosts` requirement)
   - Tighten integration-test description (Keycloak 26.4, Redis via Testcontainers)
   - Add gotcha: local Keycloak version (20.0.3) differs from IT version (26.4)
   - Remove trailing blank line at end of file
   
   **README.md**
   - Add project layout section with annotated directory tree
   - Note Docker requirement inline with `mvn verify` command
   - Add single-test run examples (`-Dtest=` / `-Dit=`)
   - Mention optional PKCE support (`pkceEnabled`)
   - Clarify OIDC config mutual-exclusivity wording
   - Add Redis optional-at-runtime note
   - Add `make sling-run` alternative in quick-start steps
   - Add Security section linking to the Sling threat model
   
   Co-authored-by: Maia <ma...@noreply>


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@sling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: update AGENTS.md and README with project layout, gotchas, and API notes [sling-org-apache-sling-auth-oauth-client]

Posted by "cziegeler (via GitHub)" <gi...@apache.org>.
cziegeler merged PR #49:
URL: https://github.com/apache/sling-org-apache-sling-auth-oauth-client/pull/49


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@sling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

Re: [PR] docs: update AGENTS.md and README with project layout, gotchas, and API notes [sling-org-apache-sling-auth-oauth-client]

Posted by "sonarqubecloud[bot] (via GitHub)" <gi...@apache.org>.
sonarqubecloud[bot] commented on PR #49:
URL: https://github.com/apache/sling-org-apache-sling-auth-oauth-client/pull/49#issuecomment-4991228405

   ## [![Quality Gate Passed](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/checks/QualityGateBadge/qg-passed-20px.png 'Quality Gate Passed')](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-auth-oauth-client&pullRequest=49) **Quality Gate passed**  
   Issues  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0 New issues](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-auth-oauth-client&pullRequest=49&issueStatuses=OPEN,CONFIRMED&sinceLeakPeriod=true)  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/accepted-16px.png '') [0 Accepted issues](https://sonarcloud.io/project/issues?id=apache_sling-org-apache-sling-auth-oauth-client&pullRequest=49&issueStatuses=ACCEPTED)
   
   Measures  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0 Security Hotspots](https://sonarcloud.io/project/security_hotspots?id=apache_sling-org-apache-sling-auth-oauth-client&pullRequest=49&issueStatuses=OPEN,CONFIRMED&sinceLeakPeriod=true)  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0.0% Coverage on New Code](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-auth-oauth-client&pullRequest=49&metric=new_coverage&view=list)  
   ![](https://sonarsource.github.io/sonarcloud-github-static-resources/v2/common/passed-16px.png '') [0.0% Duplication on New Code](https://sonarcloud.io/component_measures?id=apache_sling-org-apache-sling-auth-oauth-client&pullRequest=49&metric=new_duplicated_lines_density&view=list)  
     
   <!-- sqra-placement-anchor -->
   [See analysis details on SonarQube Cloud](https://sonarcloud.io/dashboard?id=apache_sling-org-apache-sling-auth-oauth-client&pullRequest=49)
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@sling.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org