Redmine GitHub Hook 插件使用教程

Redmine GitHub Hook 插件使用教程

redmine_github_hookAllow your Redmine installation to be notified when changes have been pushed to a Github repository. 项目地址:https://gitcode.com/gh_mirrors/re/redmine_github_hook

1. 项目的目录结构及介绍

Redmine GitHub Hook 插件的目录结构如下：

redmine_github_hook/
├── app/
├── config/
├── lang/
├── lib/
├── test/
├── .gitignore
├── CHANGELOG.md
├── Gemfile
├── LICENSE
├── README.md
├── Rakefile
├── init.rb
└── redmine_github_hook.gemspec

目录介绍

• app/: 包含应用程序的核心代码。
• config/: 包含配置文件和路由定义。
• lang/: 包含多语言支持文件。
• lib/: 包含库文件和辅助函数。
• test/: 包含测试文件。
• .gitignore: Git 忽略文件列表。
• CHANGELOG.md: 项目更新日志。
• Gemfile: 依赖的 Gem 文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• Rakefile: Rake 任务文件。
• init.rb: 插件初始化文件。
• redmine_github_hook.gemspec: 插件的 gemspec 文件。

2. 项目的启动文件介绍

项目的启动文件是 init.rb，它负责初始化插件并加载必要的依赖项。以下是 init.rb 文件的简要介绍：

# init.rb
require 'redmine'

Redmine::Plugin.register :redmine_github_hook do
  name 'Redmine GitHub Hook'
  author 'Jakob Skjerning'
  description 'Allows your Redmine installation to be notified when changes have been pushed to a Github repository'
  version '3.0.1'
  url 'https://github.com/koppen/redmine_github_hook'
  author_url 'http://mentalized.net'
end

启动文件介绍

• require 'redmine': 加载 Redmine 核心库。
• Redmine::Plugin.register: 注册插件，定义插件的名称、作者、描述、版本和 URL 等信息。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下。以下是一些关键配置文件的介绍：

config/routes.rb

# config/routes.rb
RedmineApp::Application.routes.draw do
  post 'github_hook', :to => 'github_hook#index'
end

配置文件介绍

• config/routes.rb: 定义路由规则，将 GitHub 的 Webhook 请求路由到 github_hook#index 控制器。

通过以上介绍，您可以更好地理解和使用 Redmine GitHub Hook 插件。希望本教程对您有所帮助。

redmine_github_hookAllow your Redmine installation to be notified when changes have been pushed to a Github repository. 项目地址:https://gitcode.com/gh_mirrors/re/redmine_github_hook