Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add developer docs #410

Merged
merged 7 commits into from
Oct 3, 2024
Merged

Add developer docs #410

merged 7 commits into from
Oct 3, 2024

Conversation

jtnord
Copy link
Member

@jtnord jtnord commented Oct 3, 2024

Adds some developer docs, with howto use the OpenID Connect conformance tests, as well as howto setup an ADFS instance for testing.

Testing done

the docs for ADFS where taken as I performed the steps. I could authenticate to Jenkins and retreive groups.

image

if viewing rendered markdown the image references do not work as GH is attempting to use the branchname from the origin not the fork. so in that case look at https://github.com/jtnord/oic-auth-plugin/blob/add-developer-docs/docs/developer/AD-FS/setup-test-instance.md for a rendered view.

Submitter checklist

  • Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
  • Ensure that the pull request title represents the desired changelog entry
  • Please describe what you did
  • Link to relevant issues in GitHub or Jira
  • Link to relevant pull requests, esp. upstream and downstream changes
  • Ensure you have provided tests - that demonstrates feature works or fixes the issue

This creats a working but limited ADFS setup.

Still missing: groups and refresh tokens
@jtnord jtnord requested a review from a team as a code owner October 3, 2024 11:03
Copy link

codecov bot commented Oct 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.16%. Comparing base (c6bf1a8) to head (b48a299).
Report is 10 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master     #410      +/-   ##
============================================
- Coverage     74.18%   74.16%   -0.02%     
- Complexity      257      261       +4     
============================================
  Files            15       15              
  Lines          1007     1022      +15     
  Branches        145      147       +2     
============================================
+ Hits            747      758      +11     
- Misses          187      191       +4     
  Partials         73       73              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@mikecirioli mikecirioli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wow, that is a lot of detail, thanks!

Copy link
Contributor

@PereBueno PereBueno left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great addition

@jtnord jtnord merged commit d4eba97 into jenkinsci:master Oct 3, 2024
21 of 23 checks passed
@jtnord jtnord deleted the add-developer-docs branch October 3, 2024 15:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants