git - 如何在 OpenGrok 中处理 git 分支？

Question

我们想使用 OpenGrok 索引我们的（相当大的）git 存储库，而我无法弄清楚的一件事是如何索引所有分支。从我所见，看起来我需要为每个要索引的分支签出副本，因此，如果存储库有十几个分支，我需要有十几个副本，一个对于每个分支，例如，

git-repo-with-many-branches-master/
git-repo-with-many-branches-branch1/
git-repo-with-many-branches-branch2/
       :
git-repo-with-many-branches-branch12/

这是真的吗？或者有没有办法告诉 OpenGrok在创建索引时查看所有分支？

score 7 · Accepted Answer

OpenGrok 中的其他层被设计为在多个不像 git 那样工作的 SCM 系统上工作，所以不幸的是，你必须检查你想要索引的每个分支作为单独的 git 存储库:-(

您可以随时提交 RFE 以支持浏览 git 存储库中的多个分支。

score 0 · Accepted Answer

我专门为此目的编写了一个脚本：daun。您需要在 cron 作业中使用dauncli 而不是gitcli。请注意，在撰写本文时它不支持 OpenGrok git 历史记录，因为我们只对 OpenGrok 快速搜索功能感兴趣。我们会将我们的 OpenGrok 用户指向 GitHub/Bitbucket 等工具，用于基于 Web 的 git 历史记录。

score 0 · Accepted Answer

这是我为执行此操作而编写的 bash 脚本。它将克隆任何新分支，更新任何现有分支，并删除不再存在的分支。以下是“有效”的说明；你可以选择让事情变得更安全，但如果你的服务器只能在你的局域网上访问，这就足够了。我有一个 cron 作业设置，它每 30 分钟在服务器上运行一次。要将 cron 作业设置为以 root 身份运行，请运行：

sudo crontab -e

然后粘贴这些内容：

*/30 * * * * /usr/local/bin/opengrok_index.sh

然后写入并关闭：

:wq

您将需要安装脚本用于输入 ssh 密钥密码的“expect”。这两个命令之一将根据您使用的 linux 操作系统起作用：

sudo yum install expect
sudo apt-get install expect

然后在 /usr/local/bin/opengrok_index.sh 创建一个文件：

sudo vi /usr/local/bin/opengrok_index.sh

接下来，粘贴脚本的内容（从本文底部开始），并根据您的系统更改顶部的变量。接下来，更改权限，以便只有 root 可以读取它（其中有密码）：

sudo chmod 700 /usr/local/bin/opengrok_index.sh

在期望 cron 作业正常工作之前，您可能希望手动测试运行脚本并使其正常工作。这是我为特定设置编写的特定脚本，因此您可能需要放入一些 echo 语句并进行一些调试以使其正常工作：

sudo /usr/local/bin/opengrok_index.sh

补充笔记：

此脚本通过 SSH（不是 HTTPS）登录到 GIT。因此，您的 GIT_USER 必须存在于系统上，并且在 /home/user/.ssh/id_rsa 下有一个可以访问 GIT 存储库的 SSH 密钥。这是标准的 GIT 登录内容，所以我不会在这里详细介绍。脚本会在提示时输入 GIT_USER_SSH_PASSWORD
该脚本将所有文件签出为 GIT_USER，因此您可能需要将您的 CHECKOUT_LOCATION “chown”给该用户

脚本：

#!/bin/bash

SUDO_PASSWORD="password"
CHECKOUT_LOCATION="/var/opengrok/src/"
GIT_PROJECT_NAME="Android"
GIT_USER="username"
GIT_USER_SSH_PASSWORD="password"
GIT_URL="yourgit.domain.com"
OPENGROK_BINARY_FILE="/usr/local/opengrok-0.12.1.6/bin/OpenGrok"

# Run command as GIT_USER which has Git access
function runGitCommand {
  git_command="$@"

  expect_command="
    spawn sudo -u $GIT_USER $git_command
    expect {
        \"*password for*\" {
            send \"$SUDO_PASSWORD\"
            send \"\r\"
            exp_continue
        }
        \"*Enter passphrase for key*\" {
            send \"$GIT_USER_SSH_PASSWORD\"
            send \"\r\"
            exp_continue
        }
    }"

  command_result=$(expect -c "$expect_command" || exit 1)
}

# Checkout the specified branch over the network (slow)
function checkoutBranch {
  branch=$1

  # Check out branch if it does not exist
  if [ ! -d "$branch" ]; then
    runGitCommand git clone ssh://$GIT_URL/$GIT_PROJECT_NAME
    # Rename project to the branch name
    mv $GIT_PROJECT_NAME $branch || exit 1
  # Otherwise update the existing branch
  else
    cd $branch || exit 1
    runGitCommand git fetch
    runGitCommand git pull origin $branch || exit 1
    cd ..
  fi
}

# If the branch directory does not exist, copy the master
# branch directory then switch to the desired branch.
# This is faster than checkout out over the network.
# Otherwise, update the exisiting branch directory
function updateBranch {
  branch=$1

  if [ ! -d "$branch" ]; then
    mkdir $branch || exit 1
    rsync -av master/ $branch || exit 1
    cd $branch || exit 1
    runGitCommand git checkout -b $branch origin/$branch
    cd ..
  else
    cd $branch || exit 1
    runGitCommand git pull origin $branch || exit 1
    cd ..
  fi
}

# Change to the OpenGrok indexing location to checkout code
cd $CHECKOUT_LOCATION || exit 1

# Check out master branch
checkoutBranch master

# Get a list of all remote branches
cd master || exit 1
old_ifs=$IFS
IFS=$'\n'
origin_branches=( $(git branch -r) )
IFS=$old_ifs
origin_branches_length=${#origin_branches[@]}
cd .. # Move out of "master" directory

# Loop through and check out all branches
branches=(master)
for origin_branch in "${origin_branches[@]}"
do
  # Strip the "origin/" prefix from the branch name
  branch=${origin_branch#*/}

  # Ignore the "HEAD" branch
  # Also skip master since it has already been updated
  if [[ $branch == HEAD* ]] || [[ $branch == master* ]]; then
    continue
  fi

  branches+=("$branch")
  updateBranch $branch
done

# Get list of branches currently in OpenGrok
old_ifs=$IFS
IFS=$'\n'
local_branches=( $(ls -A1) )
size=${#local_branches[@]}
IFS=$old_ifs

# Get list of branches that are in OpenGrok, but do not exist
# remotely. These are branches that have been deleted
deleted_branches=()
for local_branch in "${local_branches[@]}"
do
  skip=0

  for branch in "${branches[@]}"
  do
    if [[ $local_branch == $branch ]]; then
      skip=1;
      break;
    fi
  done

  if [[ $skip == "0" ]]; then
    deleted_branches+=("$local_branch")
  fi
done

# Change to checkout directory again, in case some future code
# change brings us somewhere else. We are deleting recursively
# here and cannot make a mistake!
cd $CHECKOUT_LOCATION
# Delete any branches that no longer exist remotely
for deleted_branch in ${deleted_branches[@]}
do
  rm -rf ./$deleted_branch
done

# Reindex OpenGrok
$OPENGROK_BINARY_FILE index

score -3 · Accepted Answer

我对 OpenGrok 一无所知，但你当然可以使用 Git 更改分支：

git checkout master
# do the indexing here
git checkout branch1
# indexing
git checkout branch2
# and so on...

git - 如何在 OpenGrok 中处理 git 分支？

4 回答 4

Related

Reference