Archived
Add OpenProject Gitea integration plugin
Implements a Gitea integration for OpenProject following the same patterns as the bundled GitHub and GitLab integrations. - Webhook endpoint at /webhooks/gitea with HMAC-SHA256 verification - Handles pull_request and issue_comment events - Links Gitea PRs to work packages via OP# references or URLs - Posts journal comments on WPs for PR lifecycle events - Gitea tab on the work package split view - V3 API endpoint: GET /api/v3/work_packages/:id/gitea_pull_requests - Admin settings UI for bot user and webhook secret - Nightly cron job to clean up unlinked PR records
This commit is contained in:
45 files changed
+2561
No files matched your search
@@ -0,0 +1,31 @@
|
||||
<%#-- copyright
|
||||
OpenProject is an open source project management software.
|
||||
Copyright (C) the OpenProject GmbH
|
||||
|
||||
This program is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public License version 3.
|
||||
|
||||
OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
Copyright (C) 2010-2013 the ChiliProject Team
|
||||
|
||||
This program is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public License
|
||||
as published by the Free Software Foundation; either version 2
|
||||
of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
See COPYRIGHT and LICENSE files for more details.
|
||||
++#%>
|
||||
<%= render(Primer::OpenProject::PageHeader.new) do |header| %>
|
||||
<% header.with_title { t(:label_gitea_integration) } %>
|
||||
<% header.with_breadcrumbs(breadcrumb_items) %>
|
||||
<% end %>
|
||||
@@ -0,0 +1,42 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
#-- copyright
|
||||
# OpenProject is an open source project management software.
|
||||
# Copyright (C) the OpenProject GmbH
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License version 3.
|
||||
#
|
||||
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
# Copyright (C) 2010-2013 the ChiliProject Team
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# See COPYRIGHT and LICENSE files for more details.
|
||||
#++
|
||||
|
||||
module GiteaIntegration
|
||||
module Admin
|
||||
class PageHeaderComponent < ApplicationComponent
|
||||
def breadcrumb_items
|
||||
[
|
||||
{ href: admin_index_path, text: t("label_administration") },
|
||||
t(:label_gitea_integration)
|
||||
]
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,65 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
#-- copyright
|
||||
# OpenProject is an open source project management software.
|
||||
# Copyright (C) the OpenProject GmbH
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License version 3.
|
||||
#
|
||||
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
# Copyright (C) 2010-2013 the ChiliProject Team
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# See COPYRIGHT and LICENSE files for more details.
|
||||
#++
|
||||
|
||||
module GiteaIntegration
|
||||
module Admin
|
||||
class SettingsController < ApplicationController
|
||||
layout "admin"
|
||||
|
||||
menu_item :admin_gitea_integration
|
||||
|
||||
before_action :require_admin
|
||||
|
||||
def show
|
||||
settings = plugin_settings
|
||||
user_id = settings[:gitea_user_id].presence
|
||||
@gitea_comment_user = user_id ? User.find_by(id: user_id) : nil
|
||||
@webhook_secret = settings[:webhook_secret]
|
||||
end
|
||||
|
||||
def update
|
||||
merged = plugin_settings.merge(permitted_params)
|
||||
Setting.plugin_openproject_gitea_integration = merged
|
||||
flash[:notice] = I18n.t(:notice_successful_update)
|
||||
redirect_to gitea_integration_admin_settings_path
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def permitted_params
|
||||
params.permit(:gitea_user_id, :webhook_secret).to_h
|
||||
end
|
||||
|
||||
def plugin_settings
|
||||
Hash(Setting.plugin_openproject_gitea_integration).with_indifferent_access
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,69 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
#-- copyright
|
||||
# OpenProject is an open source project management software.
|
||||
# Copyright (C) the OpenProject GmbH
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License version 3.
|
||||
#
|
||||
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
# Copyright (C) 2010-2013 the ChiliProject Team
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# See COPYRIGHT and LICENSE files for more details.
|
||||
#++
|
||||
|
||||
module GiteaIntegration
|
||||
module Admin
|
||||
class SettingsForm < ApplicationForm
|
||||
form do |f|
|
||||
f.autocompleter(
|
||||
name: :gitea_user_id,
|
||||
label: I18n.t(:label_gitea_actor),
|
||||
caption: I18n.t(:text_gitea_actor_info),
|
||||
autocomplete_options: {
|
||||
component: "opce-user-autocompleter",
|
||||
allowEmpty: true,
|
||||
defaultData: false,
|
||||
model: @comment_user_model
|
||||
}
|
||||
)
|
||||
|
||||
f.text_field(
|
||||
name: :webhook_secret,
|
||||
label: I18n.t(:label_gitea_webhook_secret),
|
||||
caption: I18n.t(:text_gitea_webhook_secret_info),
|
||||
value: @webhook_secret,
|
||||
input_width: :xxlarge
|
||||
)
|
||||
|
||||
f.submit(
|
||||
name: :submit,
|
||||
label: I18n.t(:button_save),
|
||||
scheme: :primary
|
||||
)
|
||||
end
|
||||
|
||||
def initialize(comment_user: nil, webhook_secret: nil)
|
||||
super()
|
||||
@comment_user_model = comment_user.present? ? { id: comment_user.id, name: comment_user.name } : nil
|
||||
@webhook_secret = webhook_secret
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,76 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
#-- copyright
|
||||
# OpenProject is an open source project management software.
|
||||
# Copyright (C) the OpenProject GmbH
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License version 3.
|
||||
#
|
||||
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
# Copyright (C) 2010-2013 the ChiliProject Team
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# See COPYRIGHT and LICENSE files for more details.
|
||||
#++
|
||||
|
||||
class GiteaPullRequest < ApplicationRecord
|
||||
LABEL_KEYS = %w[color name].freeze
|
||||
|
||||
has_and_belongs_to_many :work_packages
|
||||
belongs_to :gitea_user, optional: true
|
||||
belongs_to :merged_by, optional: true, class_name: "GiteaUser"
|
||||
|
||||
enum :state, {
|
||||
open: "open",
|
||||
closed: "closed",
|
||||
merged: "merged"
|
||||
}
|
||||
|
||||
validates :gitea_html_url,
|
||||
:number,
|
||||
:repository,
|
||||
:state,
|
||||
:title,
|
||||
:gitea_updated_at,
|
||||
presence: true
|
||||
validates :body,
|
||||
presence: { unless: :partial? }
|
||||
validate :validate_labels_schema
|
||||
|
||||
scope :without_work_package, -> { where.missing(:work_packages) }
|
||||
|
||||
def self.find_by_gitea_identifiers(url:, id: nil, initialize: false)
|
||||
raise ArgumentError, "needs a url" if url.blank?
|
||||
|
||||
found = find_by(gitea_html_url: url)
|
||||
found || (new(gitea_id: id, gitea_html_url: url) if initialize)
|
||||
end
|
||||
|
||||
def partial?
|
||||
[body].all?(&:nil?)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def validate_labels_schema
|
||||
return if labels.nil?
|
||||
return if labels.all? { |label| label.keys.sort == LABEL_KEYS }
|
||||
|
||||
errors.add(:labels, :invalid_schema)
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,39 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
#-- copyright
|
||||
# OpenProject is an open source project management software.
|
||||
# Copyright (C) the OpenProject GmbH
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License version 3.
|
||||
#
|
||||
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
# Copyright (C) 2010-2013 the ChiliProject Team
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# See COPYRIGHT and LICENSE files for more details.
|
||||
#++
|
||||
|
||||
class GiteaUser < ApplicationRecord
|
||||
has_many :gitea_pull_requests
|
||||
|
||||
validates :gitea_id,
|
||||
:gitea_name,
|
||||
:gitea_login,
|
||||
:gitea_avatar_url,
|
||||
presence: true
|
||||
end
|
||||
@@ -0,0 +1,41 @@
|
||||
<%#-- copyright
|
||||
OpenProject is an open source project management software.
|
||||
Copyright (C) the OpenProject GmbH
|
||||
|
||||
This program is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public License version 3.
|
||||
|
||||
OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
Copyright (C) 2010-2013 the ChiliProject Team
|
||||
|
||||
This program is free software; you can redistribute it and/or
|
||||
modify it under the terms of the GNU General Public License
|
||||
as published by the Free Software Foundation; either version 2
|
||||
of the License, or (at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program; if not, write to the Free Software
|
||||
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
See COPYRIGHT and LICENSE files for more details.
|
||||
++#%>
|
||||
<% html_title t(:label_administration), t(:label_gitea_integration), t(:label_setting_plural) %>
|
||||
|
||||
<%= render(GiteaIntegration::Admin::PageHeaderComponent.new) %>
|
||||
|
||||
<%= settings_primer_form_with(url: gitea_integration_admin_settings_path, method: :patch) do |f| %>
|
||||
<% if @webhook_secret.blank? %>
|
||||
<%= render(Primer::Alpha::Banner.new(scheme: :warning, icon: :alert, mb: 4)) do %>
|
||||
<%= t(:text_gitea_webhook_secret_missing_warning) %>
|
||||
<% end %>
|
||||
<% end %>
|
||||
<%= render GiteaIntegration::Admin::SettingsForm.new(f,
|
||||
comment_user: @gitea_comment_user,
|
||||
webhook_secret: @webhook_secret) %>
|
||||
<% end %>
|
||||
@@ -0,0 +1,39 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
#-- copyright
|
||||
# OpenProject is an open source project management software.
|
||||
# Copyright (C) the OpenProject GmbH
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License version 3.
|
||||
#
|
||||
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
|
||||
# Copyright (C) 2006-2013 Jean-Philippe Lang
|
||||
# Copyright (C) 2010-2013 the ChiliProject Team
|
||||
#
|
||||
# This program is free software; you can redistribute it and/or
|
||||
# modify it under the terms of the GNU General Public License
|
||||
# as published by the Free Software Foundation; either version 2
|
||||
# of the License, or (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program; if not, write to the Free Software
|
||||
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
#
|
||||
# See COPYRIGHT and LICENSE files for more details.
|
||||
#++
|
||||
|
||||
module Cron
|
||||
class ClearOldGiteaPullRequestsJob < CronJob
|
||||
self.cron_expression = "25 1 * * *"
|
||||
|
||||
def perform
|
||||
GiteaPullRequest.without_work_package.destroy_all
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in new issue
Block a user