如何通过Rails上传CSV文件至GitHub仓库？含API及UI上传场景

实现步骤 #

1. 添加依赖
   在Gemfile中引入Octokit（GitHub官方推荐的Ruby客户端库）：

gem 'octokit'

执行 bundle install 完成安装。

2. 配置GitHub认证
   在Rails环境配置文件（如config/environments/production.rb）中配置个人访问令牌（需拥有目标仓库的写入权限）：

Octokit.configure do |config|
  config.access_token = ENV['GITHUB_ACCESS_TOKEN']
end

注意：将令牌存储在环境变量中，切勿硬编码到代码里。

3. 编写上传逻辑
   创建服务类封装上传逻辑，示例如下：

class GithubCsvUploader
  def initialize(repo_name, file_path, csv_content, commit_msg = "Upload CSV file")
    @repo = repo_name # 格式："用户名/仓库名"
    @file_path = file_path # 仓库内的目标路径，例如"uploads/user_data.csv"
    @csv_content = csv_content
    @commit_msg = commit_msg
  end

  def upload
    begin
      # 检查文件是否已存在，存在则更新
      existing_file = Octokit.contents(@repo, path: @file_path)
      Octokit.update_contents(
        @repo,
        @file_path,
        @commit_msg,
        existing_file.sha,
        Base64.encode64(@csv_content)
      )
    rescue Octokit::NotFound
      # 文件不存在则创建
      Octokit.create_contents(
        @repo,
        @file_path,
        @commit_msg,
        Base64.encode64(@csv_content)
      )
    end
  end
end

在控制器中调用该服务类完成上传：

def upload_to_github
  # 示例CSV内容，实际可从生成或读取的文件获取
  csv_data = "name,email\nAlice,alice@test.com\nBob,bob@test.com"
  uploader = GithubCsvUploader.new("your-username/your-repo", "data/users.csv", csv_data)
  uploader.upload
  # 后续处理成功/失败的响应逻辑
end

存在，以下提供两种可行方案：

方案一：使用GitHub API（推荐） #

实现流程 #

1. UI上传表单
   在Rails视图中创建支持文件上传的表单：

<%= form_with url: upload_csv_path, method: :post, multipart: true do |form| %>
  <%= form.file_field :csv_file, accept: '.csv' %>
  <%= form.submit "上传至GitHub" %>
<% end %>

2. 控制器处理逻辑
   接收上传的CSV文件，读取内容后调用前面的GithubCsvUploader完成上传：

def upload_csv
  csv_file = params[:csv_file]
  if csv_file.present?
    csv_content = csv_file.read
    uploader = GithubCsvUploader.new(
      "your-username/your-repo",
      "uploads/#{csv_file.original_filename}",
      csv_content,
      "Upload CSV: #{csv_file.original_filename}"
    )
    uploader.upload
    redirect_to root_path, notice: "CSV已成功上传至GitHub仓库"
  else
    redirect_to root_path, alert: "请选择要上传的CSV文件"
  end
end

3. 配置路由
   在config/routes.rb中添加对应路由：

post '/upload-csv', to: 'csv_uploads#upload_csv', as: :upload_csv

方案二：不使用GitHub API（通过Git命令行） #

该方案直接在服务器上操作Git仓库，适合无法调用API的场景：

实现流程 #

1. 预准备：克隆仓库到服务器
   在Rails服务器上克隆目标GitHub仓库，例如存储到/var/github-repos/your-repo目录。

2. UI上传表单
   同方案一的表单实现。

3. 控制器处理逻辑
   将上传的CSV文件复制到克隆的仓库目录，执行Git命令提交并推送：

def upload_csv
  csv_file = params[:csv_file]
  if csv_file.present?
    repo_path = "/var/github-repos/your-repo"
    target_file = "#{repo_path}/uploads/#{csv_file.original_filename}"

    # 写入文件到仓库目录
    File.open(target_file, 'wb') { |f| f.write(csv_file.read) }

    # 执行Git命令提交推送
    Dir.chdir(repo_path) do
      `git add #{target_file}`
      `git commit -m "Upload CSV: #{csv_file.original_filename}"`
      `git push origin main` # 替换为你的目标分支名
    end

    redirect_to root_path, notice: "CSV已成功上传至GitHub仓库"
  else
    redirect_to root_path, alert: "请选择要上传的CSV文件"
  end
end

注意事项 #

• 确保服务器已配置GitHub SSH密钥，避免推送时需要手动验证。
• 定期拉取仓库最新代码，避免出现提交冲突。

内容的提问来源于stack exchange，提问作者Dong Jin