Skip to content

Commit

Permalink
đź“ť Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
hardbyte committed Apr 15, 2023
1 parent 01f308f commit 52477c7
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pip install netcheck
Or run with Docker:

```shell
docker run -it ghcr.io/netchecks/netchecks:latest
docker run -it ghcr.io/hardbyte/netchecks:main
```

### Individual Assertions
Expand Down Expand Up @@ -227,22 +227,22 @@ to each rule such as headers and custom validation:
"assertions": [
{"name": "get-with-header", "rules": [
{"type": "http", "url": "https://pie.dev/headers", "headers": {"X-Test-Header": "value"}},
{"type": "http", "url": "https://pie.dev/headers", "headers": {"X-Header": "secret"}, "validation": "parse_json(data.body).headers['X-Header'] == 'secret'" }
{"type": "http", "url": "https://pie.dev/headers", "headers": {"X-Header": "secret"}, "validation": "parse_json(data.body).headers['X-Header'] == 'secret'" }
]}
]
}
```

## Coming Soon

- JSON Schema for config file and outputs
- More checks

## Development

Update version in pyproject.toml, push to `main` and create a release on GitHub. Pypi release will be carried
out by GitHub actions.

Install dev dependencies with Poetry:

```
poetry install --with dev
```

### Manual Release
To release manually, use Poetry:
Expand Down
8 changes: 4 additions & 4 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 4 additions & 2 deletions tests/testdata/http-with-headers.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
"assertions": [
{"name": "get-with-header", "rules": [
{"type": "http", "url": "https://pie.dev/headers", "headers": {"X-Test-Header": "value"}},
{"type": "http", "url": "https://pie.dev/headers", "headers": {"X-Header": "secret"}, "validation": "parse_json(data.body).headers['X-Header'] == 'secret'" }
]}
{"type": "http", "url": "https://pie.dev/headers", "headers": {"X-Header": "secret"},
"validation": "parse_json(data.body).headers['X-Header'] == 'secret'" }
]
}
]
}

0 comments on commit 52477c7

Please sign in to comment.