Added Github Enterprise Support #14324
Closed
ArnaavSinghSandhu wants to merge 10000 commits intoDefectDojo:devfrom
Closed
Added Github Enterprise Support #14324ArnaavSinghSandhu wants to merge 10000 commits intoDefectDojo:devfrom
ArnaavSinghSandhu wants to merge 10000 commits intoDefectDojo:devfrom
Conversation
Loading
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
17 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds support for GitHub Enterprise (GHE) by allowing a custom API base URL in the GitHub configuration.
Previously, the integration was hardcoded to use api.github.com, which made it impossible for users on self-hosted Enterprise instances to sync findings. I've added a base_url field to the GITHUB_Conf model and updated the API logic to use it if provided.
Changes:
Model: Added base_url to GITHUB_Conf.
Logic: Patched dojo/github.py to pass the base_url variable to the Github client.
UI: Updated dojo/forms.py to include the field in the settings UI.
Database: Included migration 0260_github_conf_base_url.py and updated max_migration.txt.
Test results
Tested via unittests/test_github_issue_sync.py:
GHE Test: Verified that passing a custom URL (e.g., https://ghe.example.com/api/v3) is correctly handled by the client initialization.
Backward Compatibility: Verified that leaving the field blank defaults to the standard GitHub public API without errors.
Manual Check: Verified the field saves correctly in the database via the Django shell and admin panel.
Output:-
Checklist
[x] Submitted against dev.
[x] Meaningful PR name: Add GitHub Enterprise support via custom API base_url
[x] Python 3.13 compliant.
[x] Included migrations in dojo/db_migrations.
[x] Added unit tests.
[x] Labels: enhancement, New Migration