@verdaccio/hooks

@verdaccio/hooks - Verdaccio Hooks

Note: This package is mostly for internal use by Verdaccio and is only intended to be used with Verdaccio 6.x.

Overview

The @verdaccio/hooks package provides webhook notification capabilities for Verdaccio. It sends HTTP notifications to configured endpoints when packages are published, using Handlebars templates for message formatting.

Installation

npm install @verdaccio/hooks

Usage

import { notify } from '@verdaccio/hooks';

// Send notifications for a package publish event
await notify(packageMetadata, config, remoteUser, publishedPackage);

API

• notify(metadata, config, remoteUser, publishedPackage) - Sends notifications to all configured endpoints for a package event
• sendNotification(metadata, notify, remoteUser, publishedPackage) - Sends a single notification to a specific endpoint
• handleNotify(metadata, notifyEntry, remoteUser, publishedPackage) - Core handler that processes notification patterns, compiles Handlebars templates, and sends HTTP requests

Configuration

Notifications are configured in the Verdaccio config.yaml:

notify:
  method: POST
  headers: [{ 'Content-Type': 'application/json' }]
  endpoint: https://hooks.example.com/webhook
  content: '{"name": "{{name}}", "versions": "{{versions}}"}'

Donations

Verdaccio is run by volunteers; nobody is working full-time on it. If you find this project to be useful and would like to support its development, consider making a donation - your logo might end up in this readme.

Donate starting from $1/month or just one single contribution.

Report a vulnerability

If you want to report a security vulnerability, please follow the steps which we have defined for you in our security policy.

Open Collective Sponsors

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

Open Collective Backers

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

Special Thanks

Thanks to the following companies to help us to achieve our goals providing free open source licenses.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

FAQ / Contact / Troubleshoot

If you have any issue you can try the following options. Do not hesitate to ask or check our issues database. Perhaps someone has asked already what you are looking for.

• Blog
• Donations
• Reporting an issue
• Running discussions
• Chat
• Logos
• Docker Examples
• FAQ

License

Verdaccio is MIT licensed

The Verdaccio documentation and logos (excluding /thanks, e.g., .md, .png, .sketch files within the /assets folder) are Creative Commons licensed.