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:
quafzi committed 2026-08-28 22:33:27 +02:00
commit 5d409989df
45 files changed
+2561

No files matched your search

@@ -0,0 +1,46 @@
//-- 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 docs/COPYRIGHT.rdoc for more details.
//++
import { Component, Input, inject, ChangeDetectionStrategy } from '@angular/core';
import { WorkPackageResource } from 'core-app/features/hal/resources/work-package-resource';
import { TabComponent } from 'core-app/features/work-packages/components/wp-tabs/components/wp-tab-wrapper/tab';
import { I18nService } from 'core-app/core/i18n/i18n.service';
import { PathHelperService } from 'core-app/core/path-helper/path-helper.service';
@Component({
selector: 'gitea-tab',
templateUrl: './gitea-tab.template.html',
changeDetection: ChangeDetectionStrategy.Eager,
standalone: false,
})
export class GiteaTabComponent implements TabComponent {
readonly PathHelper = inject(PathHelperService);
readonly I18n = inject(I18nService);
@Input() public workPackage:WorkPackageResource;
}
@@ -0,0 +1 @@
<tab-prs [workPackage]="workPackage" />
+93
View File
@@ -0,0 +1,93 @@
//-- 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 docs/COPYRIGHT.rdoc for more details.
//++
import { Injector, NgModule, inject } from '@angular/core';
import { OpSharedModule } from 'core-app/shared/shared.module';
import { OpenprojectTabsModule } from 'core-app/shared/components/tabs/openproject-tabs.module';
import { WorkPackageTabsService } from 'core-app/features/work-packages/components/wp-tabs/services/wp-tabs/wp-tabs.service';
import { GiteaTabComponent } from './gitea-tab/gitea-tab.component';
import { TabPrsComponent } from './tab-prs/tab-prs.component';
import { PullRequestComponent } from './pull-request/pull-request.component';
import { WorkPackageResource } from 'core-app/features/hal/resources/work-package-resource';
import { Observable } from 'rxjs';
import { map } from 'rxjs/operators';
import { HalResourceService } from 'core-app/features/hal/services/hal-resource.service';
import { ApiV3Service } from 'core-app/core/apiv3/api-v3.service';
import { CollectionResource } from 'core-app/features/hal/resources/collection-resource';
export function workPackageGiteaCount(
workPackage:WorkPackageResource,
injector:Injector,
):Observable<number> {
const halResourceService = injector.get(HalResourceService);
const apiV3Service = injector.get(ApiV3Service);
const basePath = apiV3Service.work_packages.id(workPackage.id as string).path;
return halResourceService
.get<CollectionResource>(basePath + '/gitea_pull_requests')
.pipe(map((collection) => collection.count));
}
export function initializeGiteaIntegrationPlugin(injector:Injector) {
const wpTabService = injector.get(WorkPackageTabsService);
wpTabService.registerBefore(
'watchers',
{
component: GiteaTabComponent,
name: I18n.t('js.gitea_integration.work_packages.tab_name'),
id: 'gitea',
displayable: (workPackage) => !!workPackage.gitea,
count: workPackageGiteaCount,
},
);
}
@NgModule({
imports: [
OpSharedModule,
OpenprojectTabsModule,
],
declarations: [
GiteaTabComponent,
TabPrsComponent,
PullRequestComponent,
],
exports: [
GiteaTabComponent,
TabPrsComponent,
PullRequestComponent,
],
})
export class PluginModule {
constructor() {
const injector = inject(Injector);
initializeGiteaIntegrationPlugin(injector);
}
}
@@ -0,0 +1,50 @@
<div
class="op-pull-request--title"
[textContent]="pullRequest.title"
></div>
<span class="op-pull-request--state" [ngClass]="'op-pull-request--state_' + state">
{{ state }} |
<a
[ngClass]="'op-pull-request--link_' + state"
[href]="pullRequest.htmlUrl"
target="_blank"
rel="noopener noreferrer"
[textContent]="pullRequest.repository + '#' + pullRequest.number"
></a>
</span>
@if (pullRequest.labels && pullRequest.labels.length > 0) {
<button (click)="toggleLabels(pullRequest.number)" class="op-pull-request--label_icon" title="Show/Hide labels">
Labels
</button>
}
<div class="op-pull-request--info_created">
{{ text.label_created_by }}
<span class="op-pull-request--user">
@if (pullRequest.giteaUser) {
<span
class="op-pull-request--username"
[textContent]="pullRequest.giteaUser.login"
></span>
}
</span>
<span class="op-pull-request--date">
{{ text.label_last_updated_on }}
<op-date-time [dateTimeValue]="pullRequest.gitea_updated_at" />
</span>.
</div>
<div
class="op-pull-request--labels"
[ngClass]="'op-pull-request--labels-' + pullRequest.number"
style="display: none;">
@for (label of pullRequest.labels; track label) {
<span>
<span class="op-pull-request--label" [ngStyle]="{'background-color': label.color}">
{{ label.name }}
</span>
</span>
}
</div>
@@ -0,0 +1,66 @@
//-- 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 docs/COPYRIGHT.rdoc for more details.
//++
import { Component, Input, inject, ChangeDetectionStrategy } from '@angular/core';
import { PathHelperService } from 'core-app/core/path-helper/path-helper.service';
import { I18nService } from 'core-app/core/i18n/i18n.service';
import { IGiteaPullRequestResource } from 'core-app/features/plugins/linked/openproject-gitea_integration/typings';
@Component({
selector: 'gitea-pull-request',
templateUrl: './pull-request.component.html',
host: { class: 'op-pull-request' },
changeDetection: ChangeDetectionStrategy.Eager,
standalone: false,
})
export class PullRequestComponent {
readonly PathHelper = inject(PathHelperService);
readonly I18n = inject(I18nService);
@Input() public pullRequest:IGiteaPullRequestResource;
public text = {
label_created_by: this.I18n.t('js.label_created_by'),
label_last_updated_on: this.I18n.t('js.gitea_integration.updated_on'),
};
get state():string {
if (this.pullRequest.state === 'open') {
return this.pullRequest.draft ? 'draft' : 'open';
}
return this.pullRequest.merged ? 'merged' : 'closed';
}
toggleLabels(identifier:number|undefined):void {
if (identifier === undefined) return;
const el = document.querySelector(`.op-pull-request--labels-${identifier}`) as HTMLElement|null;
if (el) {
el.style.display = el.style.display === 'none' ? 'block' : 'none';
}
}
}
@@ -0,0 +1,69 @@
//-- 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 docs/COPYRIGHT.rdoc for more details.
//++
import { ChangeDetectorRef, Component, Input, OnInit, inject, ChangeDetectionStrategy } from '@angular/core';
import { WorkPackageResource } from 'core-app/features/hal/resources/work-package-resource';
import { HalResourceService } from 'core-app/features/hal/services/hal-resource.service';
import { CollectionResource } from 'core-app/features/hal/resources/collection-resource';
import { I18nService } from 'core-app/core/i18n/i18n.service';
import { IGiteaPullRequestResource } from 'core-app/features/plugins/linked/openproject-gitea_integration/typings';
import { ApiV3Service } from 'core-app/core/apiv3/api-v3.service';
@Component({
selector: 'tab-prs',
templateUrl: './tab-prs.template.html',
host: { class: 'op-prs' },
changeDetection: ChangeDetectionStrategy.Eager,
standalone: false,
})
export class TabPrsComponent implements OnInit {
readonly I18n = inject(I18nService);
readonly apiV3Service = inject(ApiV3Service);
readonly halResourceService = inject(HalResourceService);
readonly changeDetector = inject(ChangeDetectorRef);
@Input() public workPackage:WorkPackageResource;
public pullRequests:IGiteaPullRequestResource[] = [];
ngOnInit():void {
const basePath = this.apiV3Service.work_packages.id(this.workPackage.id as string).path;
const prsPath = `${basePath}/gitea_pull_requests`;
this.halResourceService
.get<CollectionResource<IGiteaPullRequestResource>>(prsPath)
.subscribe((value) => {
this.pullRequests = value.elements;
this.changeDetector.detectChanges();
});
}
public getEmptyText():string {
return this.I18n.t('js.gitea_integration.tab_prs.empty', { wp_id: this.workPackage.displayId });
}
}
@@ -0,0 +1,10 @@
@if (pullRequests.length === 0) {
<p
class="op-tab-content--text-box"
[innerHTML]="getEmptyText()"
></p>
}
@for (pullRequest of pullRequests; track pullRequest.id || pullRequest.htmlUrl) {
<gitea-pull-request [pullRequest]="pullRequest" />
}
+59
View File
@@ -0,0 +1,59 @@
//-- 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 docs/COPYRIGHT.rdoc for more details.
//++
import { HalResourceClass } from 'core-app/modules/hal/resources/hal-resource';
export interface IGiteaUserResource {
avatarUrl:string;
login:string;
name:string;
}
export interface IGiteaPullRequestResource extends HalResourceClass {
body?:{
format?:string;
raw?:string;
html?:string;
};
createdAt?:string;
draft?:boolean;
gitea_updated_at?:string;
gitea_html_url?:string;
htmlUrl?:string;
id?:number;
labels?:Array<{ name:string; color:string }>;
merged?:boolean;
mergedAt?:string;
mergedBy?:IGiteaUserResource;
number?:number;
repository?:string;
state?:string;
title?:string;
updatedAt?:string;
giteaUser?:IGiteaUserResource;
}