Repository navigation
docs: remove libgit2 from the gitextractor setup - #838
Merged
Merged
Conversation
gitextractor now reads repositories with the git command line, so the libgit2 build guide, pkg-config/LD_LIBRARY_PATH instructions and the libgit2 troubleshooting entries no longer apply. Document the git 2.31+ requirement instead and update the standalone-mode command. RefDiff does not depend on libgit2 either, so its Development section is removed. versioned_docs for released versions are left untouched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The DevLake backend no longer uses libgit2 or go-git:
gitextractorreads repositories with thegitcommand line (apache/devlake#9293). Update the documentation accordingly.docs/Plugins/gitextractor.md: remove the libgit2 1.3.0 / cmake /PKG_CONFIG_PATHbuild guide for Linux and macOS, and replace it with the git 2.31+ requirement. Also fix the standalone-mode command, which pointed atmain.goand used the removed-idand-dbflags (the DB now comes from.env/DB_URL).docs/DeveloperManuals/DeveloperSetup.md: add Git 2.31+ to Requirements, replace the "install plugin dependencies (RefDiff)" step with the git requirement, and replace thelibgit2.so.1.3troubleshooting entry with agit: executable file not foundone.docs/Plugins/refdiff.md: remove the "depends on libgit2" Development section. RefDiff does not use libgit2 directly.docs/Troubleshooting/Configuration.md:IN_SECURE_SKIP_VERIFY=truenow also disables TLS verification for the git clone (GIT_SSL_NO_VERIFY=true); the root-CA approach is still recommended.versioned_docs/is intentionally untouched: those pages document released versions that did use libgit2.Does this close any open issues?
N/A
Screenshots
N/A
Other Information
Docs only; the site build is left to CI.