diff --git a/README.md b/README.md index c8fcae6..48cae76 100644 --- a/README.md +++ b/README.md @@ -1,51 +1,26 @@ -# Moodle WebHook's -[![GitHub Release](https://img.shields.io/github/release/valentineus/moodle-webhooks.svg)](https://github.com/valentineus/moodle-webhooks/releases) -[![Build Status](https://travis-ci.org/valentineus/moodle-webhooks.svg?branch=master)](https://travis-ci.org/valentineus/moodle-webhooks) -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/376ab669f2d3436884015554f686a915)](https://www.codacy.com/app/valentineus/moodle-webhooks) -[![Gitter Badge](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/valentineus/moodle-webhooks) +# Moodle Webhooks -Adding Webhooks to Moodle. -The Webhooks feature allows applications to receive real-time notification of changes to certain data. +`local_webhooks` is a Moodle local plugin under active modernization. -Using Webhooks, your application will be able to receive notifications of changes to selected topics and their fields. -Because of this, you do not have to rely on continuous or even periodic requests to check for updates. -Notifications about Webhooks updates are sent as POST requests to the callback URL you specified. -Notifications can indicate the very fact of a field change or include a new value. +## Status -Features: +[Gitea](https://code.popov.link/moodle/local_webhooks) is the source of truth. GitHub is intentionally a stale mirror. -* Use any number of services for notification; -* Customizing each external service; -* Interception of all events in the Moodle system; -* Use a secret phrase to authenticate requests; -* [JSON](https://en.wikipedia.org/wiki/JSON) - Format of outgoing data; +The `develop` branch is unreleased modernization work toward `6.0.0` and is not production-ready. Synchronous delivery and the legacy administration/configuration UI are disabled, so this branch sends no webhook requests. -## Installation +## Current CI baseline -Get the installation package in any of the available methods: +Gitea Actions currently tests only Moodle `5.2.2` on PHP `8.4` with PostgreSQL `16`. This is a development baseline, not the final support matrix. -* [GitHub Releases](https://github.com/valentineus/moodle-webhooks/releases). -* [Compilation from the source code](#build). +Run the same checks from the repository root with Docker: -## Build - -Self-assembly package is as follows: - -* Clone the repository: ```bash -git clone https://github.com/valentineus/moodle-webhooks.git moodle-webhooks -``` - -* Run the build script: -```bash -cd ./moodle-webhooks -/bin/sh build.sh +export COMPOSE_PROJECT_NAME=local_webhooks_local +docker compose build --pull ci +docker compose up --abort-on-container-exit --exit-code-from ci +docker compose down --volumes --remove-orphans ``` ## License -GNU Banner - -[GNU GPLv3](LICENSE.txt). -Copyright (c) -[Valentin Popov](mailto:info@valentineus.link). \ No newline at end of file +[GNU GPLv3](LICENSE.txt). Copyright (c) [Valentin Popov](mailto:info@valentineus.link).