specs/README.md

+++
extra.pipeline = "endpoints"
template = "project.html"
+++

# Webhook endpoints

This repository contains the specification and tests for the forge webhook endpoints.

# Running tests

Running tests requires the bats framework (`apt install bats`). You can run the `test.sh` script to start the tests. If you are not running from the implementation's folder, you may pass it as first argument the path to the program starting the local server (for tests).

```
$ ./test_web.sh ~/endpoints.php/server
```

If you're running test for a CLI program to check credentials (like [whck](https://tildegit.org/forge/whck)), use test_cli.sh instead:

```
$ ./test_cli.sh ~/whck/target/debug/whck
```
Update frontmatter 2020-09-30 14:14:52 +00:00			`+++`
			`extra.pipeline = "endpoints"`
			`template = "project.html"`
			`+++`

First commit 2020-09-29 10:37:55 +00:00			`# Webhook endpoints`

			`This repository contains the specification and tests for the forge webhook endpoints.`

			`# Running tests`

			Running tests requires the bats framework (`apt install bats`). You can run the `test.sh` script to start the tests. If you are not running from the implementation's folder, you may pass it as first argument the path to the program starting the local server (for tests).

			```
WIP: Include tests for CLI whck Web tests for endpoints.php are probably broken at this point. Will be fixed in a later commit. 2022-02-18 23:03:02 +00:00			`$ ./test_web.sh ~/endpoints.php/server`
			```

			`If you're running test for a CLI program to check credentials (like [whck](https://tildegit.org/forge/whck)), use test_cli.sh instead:`

			```
			`$ ./test_cli.sh ~/whck/target/debug/whck`
First commit 2020-09-29 10:37:55 +00:00			```