npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

gitea-webhook-handler

v1.0.6

Published

Web handler / middleware for processing Gitea Webhooks

Downloads

3

Readme

gitea-webhook-handler

NPM

Gitea allows you to register Webhooks for your repositories. Each time an event occurs on your repository, whether it be pushing code, filling issues or creating pull requests, the webhook address you register can be configured to be pinged with details.

This library is a small handler (or "middleware" if you must) for Node.js web servers that handles all the logic of receiving and verifying webhook requests from Gitea.

Tips

In Gitea Webhooks settings, Content type must be application/json.

application/x-www-form-urlencoded won't work at present.

Example

var http = require('http')
var createHandler = require('gitea-webhook-handler')
var handler = createHandler({ path: '/webhook', secret: 'myhashsecret' })

http.createServer(function (req, res) {
  handler(req, res, function (err) {
    res.statusCode = 404
    res.end('no such location')
  })
}).listen(7777)

handler.on('error', function (err) {
  console.error('Error:', err.message)
})

handler.on('push', function (event) {
  console.log('Received a push event for %s to %s',
    event.payload.repository.name,
    event.payload.ref)
})

handler.on('issues', function (event) {
  console.log('Received an issue event for %s action=%s: #%d %s',
    event.payload.repository.name,
    event.payload.action,
    event.payload.issue.number,
    event.payload.issue.title)
})

for multiple handlers, please see multiple-handlers-issue.

API

gitea-webhook-handler exports a single function, use this function to create a webhook handler by passing in an options object. Your options object should contain:

  • "path": the complete case sensitive path/route to match when looking at req.url for incoming requests. Any request not matching this path will cause the callback function to the handler to be called (sometimes called the next handler).
  • "secret": this is a hash key used for creating the SHA-1 HMAC signature of the JSON blob sent by Gitea. You should register the same secret key with Gitea. Any request not delivering a X-Gitea-Signature that matches the signature generated using this key against the blob will be rejected and cause an 'error' event (also the callback will be called with an Error object).
  • "events": an optional array of whitelisted event types (see: events.json). If defined, any incoming request whose X-Gitea-Event can't be found in the whitelist will be rejected. If only a single event type is acceptable, this option can also be a string.

The resulting handler function acts like a common "middleware" handler that you can insert into a processing chain. It takes request, response, and callback arguments. The callback is not called if the request is successfully handled, otherwise it is called either with an Error or no arguments.

The handler function is also an EventEmitter that you can register to listen to any of the Gitea event types. Note you can be specific in your Gitea configuration about which events you wish to receive, or you can send them all. Note that the "error" event will be liberally used, even if someone tries the end-point and they can't generate a proper signature, so you should at least register a listener for it or it will throw.

See the Gitea Webhooks documentation for more details on the events you can receive.

Included in the distribution is an events.json file which maps the event names to descriptions taken from the API:

var events = require('gitea-webhook-handler/events')
Object.keys(events).forEach(function (event) {
  console.log(event, '=', events[event])
})

Additionally, there is a special '*' even you can listen to in order to receive everything.

License

gitea-webhook-handler is Copyright (c) 2020 Chazza and licensed under the MIT License. All rights not explicitly granted in the MIT License are reserved. See the included LICENSE.md file for more details.