Redmine Custom Workflows 插件安装与使用教程

Redmine Custom Workflows 插件安装与使用教程

项目地址:https://gitcode.com/gh_mirrors/re/redmine_custom_workflows

1. 项目目录结构及介绍

Redmine Custom Workflows 插件的目录结构如下：

redmine_custom_workflows/
├── assets/
│   └── stylesheets/
├── config/
├── db/
│   └── migrate/
├── lib/
├── test/
├── github/
│   └── workflows/
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Gemfile
├── LICENSE
├── README.md
├── after_init.rb
├── init.rb
└── rubocop.yml

目录结构介绍

• assets/stylesheets/: 存放插件的样式文件。
• config/: 存放插件的配置文件。
• db/migrate/: 存放数据库迁移文件。
• lib/: 存放插件的核心代码。
• test/: 存放插件的测试代码。
• github/workflows/: 存放GitHub Actions的工作流配置文件。
• CHANGELOG.md: 记录插件的更新日志。
• CODE_OF_CONDUCT.md: 插件的代码行为准则。
• CONTRIBUTING.md: 插件的贡献指南。
• Gemfile: 插件的依赖管理文件。
• LICENSE: 插件的许可证文件。
• README.md: 插件的介绍和使用说明。
• after_init.rb: 插件初始化后的执行文件。
• init.rb: 插件的初始化文件。
• rubocop.yml: RuboCop的配置文件，用于代码风格检查。

2. 项目的启动文件介绍

init.rb

init.rb 是插件的初始化文件，负责加载插件并注册到Redmine中。该文件通常包含以下内容：

require 'redmine'

Redmine::Plugin.register :redmine_custom_workflows do
  name 'Custom Workflows'
  author 'Karel Pičman'
  description 'Allows to create custom workflows for Redmine'
  version '2.1.2'
  url 'https://github.com/anteo/redmine_custom_workflows'
  author_url 'https://github.com/anteo'

  requires_redmine version_or_higher: '4.1.0'
end

require 'redmine_custom_workflows/patches'
require 'redmine_custom_workflows/hooks'

after_init.rb

after_init.rb 是插件初始化后的执行文件，通常用于执行一些需要在插件加载后立即执行的操作。

3. 项目的配置文件介绍

config/ 目录

config/ 目录下通常存放插件的配置文件，例如：

• routes.rb: 定义插件的路由配置。
• settings.yml: 插件的默认设置。

Gemfile

Gemfile 是插件的依赖管理文件，定义了插件运行所需的Ruby gems。例如：

source 'https://rubygems.org'

gem 'redmine', '>= 4.1.0'
gem 'rails', '~> 5.2.4'

rubocop.yml

rubocop.yml 是RuboCop的配置文件，用于定义代码风格检查的规则。例如：

AllCops:
  TargetRubyVersion: 2.6

Metrics/LineLength:
  Max: 120

通过以上配置文件，可以确保插件在Redmine中正确加载并运行。

redmine_custom_workflows Allows to create custom workflows for Redmine 项目地址: https://gitcode.com/gh_mirrors/re/redmine_custom_workflows