Skip to content

Commit 2d34ceb

Browse files
authored
Merge pull request #1 from jsr-probitas/feature/add-ci-and-docs
Add CI badges and Dockerfile labels
2 parents ddf0f4e + 481e2f6 commit 2d34ceb

File tree

5 files changed

+36
-5
lines changed

5 files changed

+36
-5
lines changed

.github/workflows/build.echo-graphql.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,28 +17,40 @@ on:
1717
jobs:
1818
check:
1919
runs-on: ubuntu-latest
20+
permissions:
21+
id-token: "write"
22+
contents: "read"
2023
steps:
2124
- uses: actions/checkout@v4
2225
- uses: DeterminateSystems/nix-installer-action@main
2326
- uses: DeterminateSystems/magic-nix-cache-action@main
27+
- uses: DeterminateSystems/flake-checker-action@main
2428
- run: nix develop -c just echo-graphql::lint
2529
- run: nix develop -c just echo-graphql::fmt
2630
- run: git diff --exit-code
2731

2832
test:
2933
needs: check
3034
runs-on: ubuntu-latest
35+
permissions:
36+
id-token: "write"
37+
contents: "read"
3138
steps:
3239
- uses: actions/checkout@v4
3340
- uses: DeterminateSystems/nix-installer-action@main
3441
- uses: DeterminateSystems/magic-nix-cache-action@main
42+
- uses: DeterminateSystems/flake-checker-action@main
3543
- run: nix develop -c just echo-graphql::test
3644

3745
build:
3846
needs: check
3947
runs-on: ubuntu-latest
48+
permissions:
49+
id-token: "write"
50+
contents: "read"
4051
steps:
4152
- uses: actions/checkout@v4
4253
- uses: DeterminateSystems/nix-installer-action@main
4354
- uses: DeterminateSystems/magic-nix-cache-action@main
55+
- uses: DeterminateSystems/flake-checker-action@main
4456
- run: nix develop -c just echo-graphql::build

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# Probitas Test Servers
22

3+
[![Build echo-http](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-http.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-http.yml)
4+
[![Build echo-grpc](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-grpc.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-grpc.yml)
5+
[![Build echo-graphql](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-graphql.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-graphql.yml)
6+
37
Docker images for testing [Probitas](https://github.com/jsr-probitas/probitas)
48
clients.
59

610
## Images
711

8-
| Image | Protocol | Default Port |
9-
| ----------------------------------- | -------- | ------------ |
10-
| `ghcr.io/jsr-probitas/echo-http` | HTTP | 80 |
11-
| `ghcr.io/jsr-probitas/echo-grpc` | gRPC | 50051 |
12-
| `ghcr.io/jsr-probitas/echo-graphql` | GraphQL | 8080 |
12+
| Image | Protocol | Default Port | Status |
13+
| ----------------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14+
| `ghcr.io/jsr-probitas/echo-http` | HTTP | 80 | [![Docker](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-http.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-http.yml) |
15+
| `ghcr.io/jsr-probitas/echo-grpc` | gRPC | 50051 | [![Docker](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-grpc.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-grpc.yml) |
16+
| `ghcr.io/jsr-probitas/echo-graphql` | GraphQL | 8080 | [![Docker](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-graphql.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-graphql.yml) |
1317

1418
## Quick Start
1519

echo-graphql/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# echo-graphql
22

3+
[![Build](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-graphql.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-graphql.yml)
4+
[![Docker](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-graphql.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-graphql.yml)
5+
36
GraphQL echo server for testing GraphQL clients.
47

58
## Image
@@ -64,6 +67,8 @@ type Subscription {
6467
}
6568
```
6669

70+
See [docs/api.md](./docs/api.md) for detailed API reference.
71+
6772
## Features
6873

6974
| Feature | Description |

echo-grpc/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# echo-grpc
22

3+
[![Build](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-grpc.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-grpc.yml)
4+
[![Docker](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-grpc.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-grpc.yml)
5+
36
gRPC echo server for testing gRPC clients.
47

58
## Image
@@ -45,6 +48,8 @@ service Echo {
4548
}
4649
```
4750

51+
See [docs/api.md](./docs/api.md) for detailed API reference.
52+
4853
## Features
4954

5055
| Feature | Description |

echo-http/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# echo-http
22

3+
[![Build](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-http.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/build.echo-http.yml)
4+
[![Docker](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-http.yml/badge.svg)](https://github.com/jsr-probitas/dockerfiles/actions/workflows/docker.echo-http.yml)
5+
36
HTTP echo server for testing HTTP clients.
47

58
## Image
@@ -43,6 +46,8 @@ docker run -p 8080:8080 -v $(pwd)/.env:/app/.env ghcr.io/jsr-probitas/echo-http:
4346
| `/delay/{seconds}` | GET | Echo after delay |
4447
| `/health` | GET | Health check |
4548

49+
See [docs/api.md](./docs/api.md) for detailed API reference.
50+
4651
## Response Format
4752

4853
```json

0 commit comments

Comments
 (0)