1
1
mirror of https://github.com/go-gitea/gitea synced 2024-11-07 10:44:26 +00:00
Git with a cup of tea, painless self-hosted git service https://gitea.io
Go to file
oliverpool 26653b196b
Store webhook event in database (#29145)
Refactor the webhook logic, to have the type-dependent processing happen
only in one place.

---

## Current webhook flow

1. An event happens
2. It is pre-processed (depending on the webhook type) and its body is
added to a task queue
3. When the task is processed, some more logic (depending on the webhook
type as well) is applied to make an HTTP request

This means that webhook-type dependant logic is needed in step 2 and 3.
This is cumbersome and brittle to maintain.

Updated webhook flow with this PR:
1. An event happens
2. It is stored as-is and added to a task queue
3. When the task is processed, the event is processed (depending on the
webhook type) to make an HTTP request

So the only webhook-type dependent logic happens in one place (step 3)
which should be much more robust.

## Consequences of the refactor

- the raw event must be stored in the hooktask (until now, the
pre-processed body was stored)
- to ensure that previous hooktasks are correctly sent, a
`payload_version` is added (version 1: the body has already been
pre-process / version 2: the body is the raw event)

So future webhook additions will only have to deal with creating an
http.Request based on the raw event (no need to adjust the code in
multiple places, like currently).

Moreover since this processing happens when fetching from the task
queue, it ensures that the queuing of new events (upon a `git push` for
instance) does not get slowed down by a slow webhook.

As a concrete example, the PR #19307 for custom webhooks, should be
substantially smaller:
- no need to change `services/webhook/deliver.go` 
- minimal change in `services/webhook/webhook.go` (add the new webhook
to the map)
- no need to change all the individual webhook files (since with this
refactor the `*webhook_model.Webhook` is provided as argument)
2024-03-07 23:18:38 +01:00
.devcontainer bump to use go 1.22 (#29119) 2024-02-14 18:19:57 +00:00
.gitea Use docs.gitea.com instead of docs.gitea.io (#26739) 2023-08-27 11:59:12 +00:00
.github Fix bug hidden on CI and make ci failed if tests failure (#29254) 2024-03-07 17:43:32 +01:00
assets Revert "Support SAML authentication (#25165)" (#29358) 2024-02-24 12:18:49 +08:00
build Refactor generate-svg.js (#29348) 2024-02-23 22:07:27 +00:00
cmd Move some asymkey functions to service layer (#28894) 2024-03-04 08:57:39 +00:00
contrib gitea.service: Remove syslog.target (#29550) 2024-03-02 18:44:43 -05:00
custom/conf Allow options to disable user ssh keys configuration from the interface on app.ini (#29447) 2024-03-04 07:50:21 +00:00
docker Dockerfile small refactor (#27757) 2023-10-29 09:44:06 +08:00
docs Replace more gt- with tw-, update frontend docs (#29595) 2024-03-05 05:29:32 +00:00
models Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
modules Avoid unexpected panic in graceful manager (#29629) 2024-03-06 11:50:39 +00:00
options Detect broken git hooks (#29494) 2024-03-06 09:56:04 +00:00
public Update various logos and unify their filenames (#29637) 2024-03-06 22:20:05 +00:00
routers Update various logos and unify their filenames (#29637) 2024-03-06 22:20:05 +00:00
services Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
snap bump to use go 1.22 (#29119) 2024-02-14 18:19:57 +00:00
templates Store webhook event in database (#29145) 2024-03-07 23:18:38 +01:00
tests Sync branches to DB immediately when handle git hook calling (#29493) 2024-03-06 16:47:52 +08:00
web_src Remove jQuery AJAX from the repo editor (#29636) 2024-03-07 07:28:33 +00:00
.air.toml Reduce verbosity of dev commands (#24917) 2023-05-24 20:11:04 +00:00
.changelog.yml Adapt .changelog.yml to new labeling system (#27701) 2023-10-20 00:22:00 +02:00
.dockerignore Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
.editorconfig Add markdownlint (#20512) 2022-07-28 09:22:47 +08:00
.eslintrc.yaml Remove jQuery .map() and enable eslint rules for it (#29272) 2024-02-21 00:05:17 +00:00
.gitattributes Move public asset files to the proper directory (#25907) 2023-07-18 18:06:43 +02:00
.gitignore Ignore __debug_bin* which is generated by vscode when debugging (#29524) 2024-03-01 22:18:35 +08:00
.gitpod.yml Fix Gitpod logic of setting ROOT_URL (#29162) 2024-02-13 17:57:55 -05:00
.golangci.yml Remove go versions from .golangci.yml (#27953) 2023-11-07 22:03:27 +01:00
.ignore Add /public/assets to .ignore (#26232) 2023-07-30 12:34:20 +02:00
.markdownlint.yaml Enable markdownlint no-trailing-punctuation and no-blanks-blockquote (#29214) 2024-02-17 13:18:05 +00:00
.npmrc Upgrade to npm lockfile v3 and explicitely set it (#23561) 2023-03-18 19:38:10 +01:00
.spectral.yaml Add spectral linter for Swagger (#20321) 2022-07-11 18:07:16 -05:00
.stylelintrc.yaml Update js and py dependencies, bump python (#29561) 2024-03-03 17:23:14 +01:00
.yamllint.yaml fully replace drone with actions (#27556) 2023-10-11 06:39:32 +00:00
BSDmakefile Fix build errors on BSD (in BSDMakefile) (#27594) 2023-10-13 15:38:27 +00:00
build.go User/Org Feed render description as per web (#23887) 2023-04-04 04:39:47 +01:00
CHANGELOG.md Adjust changelog for v1.21.6 to move prs to correct labels (#29339) (#29343) 2024-02-23 12:09:18 +01:00
CODE_OF_CONDUCT.md Add Gitea Community Code of Conduct (#23188) 2023-03-09 10:49:34 +08:00
CONTRIBUTING.md Document that all unmerged feature PRs will be moved to next milestone when the feature freeze time comes (#29578) 2024-03-04 13:51:12 +00:00
DCO Remove address from DCO (#22595) 2023-01-24 18:52:38 +00:00
Dockerfile bump to use go 1.22 (#29119) 2024-02-14 18:19:57 +00:00
Dockerfile.rootless bump to use go 1.22 (#29119) 2024-02-14 18:19:57 +00:00
go.mod bump protobuf module (#29617) 2024-03-05 20:35:29 -05:00
go.sum bump protobuf module (#29617) 2024-03-05 20:35:29 -05:00
LICENSE Fix typo 2016-11-08 08:42:05 +01:00
main.go Fix incorrect CLI exit code and duplicate error message (#26346) 2023-08-05 23:36:45 +08:00
MAINTAINERS Apply to become a maintainer (zokkis) (#29383) 2024-02-24 14:19:49 -06:00
Makefile Fix bug hidden on CI and make ci failed if tests failure (#29254) 2024-03-07 17:43:32 +01:00
package-lock.json Inline the css-variables-parser dependency (#29571) 2024-03-04 05:55:17 +00:00
package.json Inline the css-variables-parser dependency (#29571) 2024-03-04 05:55:17 +00:00
playwright.config.js Update JS dependencies and eslint config (#21388) 2022-10-10 20:02:20 +08:00
poetry.lock Update js and py dependencies, bump python (#29561) 2024-03-03 17:23:14 +01:00
poetry.toml Clean up pyproject.toml and package.json, fix poetry options (#25327) 2023-06-18 18:13:08 +00:00
pyproject.toml Update js and py dependencies, bump python (#29561) 2024-03-03 17:23:14 +01:00
README_ZH.md Remove bountysource (#29330) 2024-02-22 19:53:03 +01:00
README.md Remove bountysource (#29330) 2024-02-22 19:53:03 +01:00
SECURITY.md fix wording in SECURITY.md (#27463) 2023-10-06 05:17:29 +08:00
tailwind.config.js Adjust tailwind content globs (#29596) 2024-03-05 04:31:29 +00:00
vitest.config.js Move vitest setup file to root (#29097) 2024-02-08 20:07:02 +08:00
webpack.config.js Add tailwindcss (#29357) 2024-02-25 17:46:46 +01:00

Gitea

Gitea - Git with a cup of tea

Contribute with Gitpod

View this document in Chinese

Purpose

The goal of this project is to make the easiest, fastest, and most painless way of setting up a self-hosted Git service.

As Gitea is written in Go, it works across all the platforms and architectures that are supported by Go, including Linux, macOS, and Windows on x86, amd64, ARM and PowerPC architectures. This project has been forked from Gogs since November of 2016, but a lot has changed.

For online demonstrations, you can visit try.gitea.io.

For accessing free Gitea service (with a limited number of repositories), you can visit gitea.com.

To quickly deploy your own dedicated Gitea instance on Gitea Cloud, you can start a free trial at cloud.gitea.com.

Building

From the root of the source tree, run:

TAGS="bindata" make build

or if SQLite support is required:

TAGS="bindata sqlite sqlite_unlock_notify" make build

The build target is split into two sub-targets:

  • make backend which requires Go Stable, the required version is defined in go.mod.
  • make frontend which requires Node.js LTS or greater.

Internet connectivity is required to download the go and npm modules. When building from the official source tarballs which include pre-built frontend files, the frontend target will not be triggered, making it possible to build without Node.js.

More info: https://docs.gitea.com/installation/install-from-source

Using

./gitea web

Note

If you're interested in using our APIs, we have experimental support with documentation.

Contributing

Expected workflow is: Fork -> Patch -> Push -> Pull Request

Note

  1. YOU MUST READ THE CONTRIBUTORS GUIDE BEFORE STARTING TO WORK ON A PULL REQUEST.
  2. If you have found a vulnerability in the project, please write privately to security@gitea.io. Thanks!

Translating

Translations are done through Crowdin. If you want to translate to a new language ask one of the managers in the Crowdin project to add a new language there.

You can also just create an issue for adding a language or ask on discord on the #translation channel. If you need context or find some translation issues, you can leave a comment on the string or ask on Discord. For general translation questions there is a section in the docs. Currently a bit empty but we hope to fill it as questions pop up.

https://docs.gitea.com/contributing/localization

Crowdin

Further information

For more information and instructions about how to install Gitea, please look at our documentation. If you have questions that are not covered by the documentation, you can get in contact with us on our Discord server or create a post in the discourse forum.

We maintain a list of Gitea-related projects at gitea/awesome-gitea.

The official Gitea CLI is developed at gitea/tea.

Authors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

FAQ

How do you pronounce Gitea?

Gitea is pronounced /ɡɪti:/ as in "gi-tea" with a hard g.

Why is this not hosted on a Gitea instance?

We're working on it.

License

This project is licensed under the MIT License. See the LICENSE file for the full license text.

Screenshots

Looking for an overview of the interface? Check it out!

Dashboard User Profile Global Issues
Branches Web Editor Activity
New Migration Migrating Pull Request View
Pull Request Dark Diff Review Dark Diff Dark