Skip to content

Commit 994a9d8

Browse files
authored
chore: update docker action (#40)
* chore: update docker image action * chore: update readme with release instructions and upgrade deps
1 parent 9e5b25f commit 994a9d8

File tree

4 files changed

+47
-47
lines changed

4 files changed

+47
-47
lines changed

.github/workflows/dockerimage.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
name: Build and push image to registry
2525
runs-on: ubuntu-latest
2626
steps:
27-
- uses: actions/checkout@v2
27+
- uses: actions/checkout@v6
2828
with:
2929
ref: ${{ github.event.inputs.ref }}
3030

README.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,23 @@ The user should have the rights read, write, create and owner.
99

1010
![rights](./rights.png)
1111

12+
## Env variables
13+
14+
Those env variables must be defined:
15+
16+
- REST_ON_COUCH_URL
17+
- REST_ON_COUCH_DATABASE
18+
- REST_ON_COUCH_ACCESS_TOKEN
19+
- SERVER_PORT
20+
- PRINTER_PROTOCOL - can be http or tcp, default is `http`
21+
- DISABLE_MONITOR - Do not update registered printers' status in the database, default is `false`
22+
- HOST - Server host, e.g. `printers.my-domain.com`, default is `127.0.0.1:<PORT>` - Only needed if you want to expose the swagger documentation of the service.
23+
- BASE_PATH - Base path for the server, default is `/` - Only needed if you want to expose the swagger documentation of the service.
24+
1225
# Development
1326

27+
## Run in development
28+
1429
Run a dev server which restarts automatically on code changes:
1530

1631
```bash
@@ -20,15 +35,8 @@ npm run dev
2035
The dev server has monitoring disabled so it won't be doing DB operations.
2136
The docs can be accessed on http://127.0.0.1:7770/documentation
2237

23-
## Env variables
38+
## Publish a new version
2439

25-
Those env variables must be defined:
40+
To publish a new version, create a github release with a new tag `vX.Y.Z` and the package will be automatically published to github's docker registry.
2641

27-
- REST_ON_COUCH_URL
28-
- REST_ON_COUCH_DATABASE
29-
- REST_ON_COUCH_ACCESS_TOKEN
30-
- SERVER_PORT
31-
- PRINTER_PROTOCOL - can be http or tcp, default is `http`
32-
- DISABLE_MONITOR - Do not update registered printers' status in the database, default is `false`
33-
- HOST - Server host, e.g. `printers.my-domain.com`, default is `127.0.0.1:<PORT>` - Only needed if you want to expose the swagger documentation of the service.
34-
- BASE_PATH - Base path for the server, default is `/` - Only needed if you want to expose the swagger documentation of the service.
42+
Use the "Generate changelog" feature to autofill the description of the release.

package-lock.json

Lines changed: 25 additions & 33 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"private": true,
33
"name": "stock-printer-proxy",
4-
"version": "6.4.0",
4+
"version": "0.0.0",
55
"description": "A public server to proxy requests to printers on the intranet",
66
"repository": "git@github.com:cheminfo/stock-printer-proxy.git",
77
"author": "Daniel Kostro <kostro.d@gmail.com>",
@@ -12,7 +12,7 @@
1212
"@fastify/swagger": "^9.6.1",
1313
"@fastify/swagger-ui": "^5.2.3",
1414
"@sinclair/typebox": "^0.34.41",
15-
"body-parser": "^2.2.0",
15+
"body-parser": "^2.2.1",
1616
"fastify": "^5.6.2",
1717
"fastify-graceful-shutdown": "^5.0.0",
1818
"rest-on-couch-client": "^6.0.0",
@@ -25,7 +25,7 @@
2525
"eslint": "^9.39.1",
2626
"eslint-config-zakodium": "^18.0.0",
2727
"expect": "^30.2.0",
28-
"prettier": "^3.6.2",
28+
"prettier": "^3.7.1",
2929
"typescript": "^5.9.3"
3030
},
3131
"scripts": {

0 commit comments

Comments
 (0)