gitea-obs/README.adoc

50 lines
1.7 KiB
Plaintext
Raw Normal View History

2017-12-02 22:07:25 +01:00
gitea-obs
=========
'gitea-obs' is a webhook endpoint to trigger the services in Open Build Service,
meant as a replacement for the Obs service on GitHub.
Unfortunately someone thought I wasn't being funny with my project names and
blocked my OBS account before I could test it. Therefore it comes as is.
Usage
-----
$ go build
$ mkdir gitea-obs-workdir
$ cd gitea-obs-workdir
$ ../gitea-obs :3000 secret
Then, in Gitea, assuming it's running on the same machine as the program,
use a 'Payload URL' like the following:
http://localhost:3000/?token=TOKEN
Optional arguments:
* 'project' is the OBS project name (when not implied by the token itself)
* 'package' is the OBS package name (when not implied by the token itself)
* 'refs' is a colon-separated list of Go filepath patterns to filter branches,
for example 'refs/heads/*'; defaults to 'refs/heads/master'
* 'obs' specifies a different URL for the OBS instance
The program uses the current working directory as a dispatch queue, and it must
be run in a dedicated directory.
Contributing and Support
------------------------
Use https://git.janouch.name/p/gitea-obs to report any bugs, request features,
or submit pull requests. If you want to discuss this project, or maybe just
hang out with the developer, feel free to join me at irc://irc.janouch.name,
channel #dev.
License
-------
'gitea-obs' is written by Přemysl Janouch <p.janouch@gmail.com>.
You may use the software under the terms of the ISC license, the text of which
is included within the package, or, at your option, you may relicense the work
under the MIT or the Modified BSD License, as listed at the following site:
http://www.gnu.org/licenses/license-list.html