Skip to content

Commit 520aa46

Browse files
authored
Merge pull request #4 from wuespace/jsr-publishing
Jsr publishing
2 parents 342a261 + 556cd9a commit 520aa46

File tree

6 files changed

+38
-12
lines changed

6 files changed

+38
-12
lines changed

.github/workflows/publish-jsr.yml

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Publish on JSR
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
jobs:
8+
publish:
9+
runs-on: ubuntu-latest
10+
11+
permissions:
12+
contents: read
13+
id-token: write
14+
15+
steps:
16+
- uses: actions/checkout@v4
17+
- name: Publish package
18+
run: npx jsr publish
19+
- name: Setup Deno Environment
20+
uses: denoland/setup-deno@v2
21+
with:
22+
deno-version: v2.x
23+
- name: Test that things are working
24+
run: deno task run
25+
- name: Publish to JSR
26+
run: deno publish

Dockerfile

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
FROM denoland/deno:2.1.3
22

3-
COPY . /envdoc
4-
WORKDIR /envdoc
3+
COPY . /envardoc
4+
WORKDIR /envardoc
55

66
RUN deno compile --allow-read main.ts
77

88
FROM gcr.io/distroless/cc-debian12
99

10-
COPY --from=0 /envdoc/envdoc /envdoc
10+
COPY --from=0 /envardoc/envardoc /envardoc
1111

1212
WORKDIR /data
1313

14-
ENTRYPOINT [ "/envdoc" ]
14+
ENTRYPOINT [ "/envardoc" ]

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# envdoc
1+
# envardoc
22

33
A documentation generator for .env files.
44

55
## Usage
66

77
```shell
8-
envdoc <writer> <path-to-env-file>
8+
envardoc <writer> <path-to-env-file>
99
```
1010

1111
### Writers
@@ -16,13 +16,13 @@ envdoc <writer> <path-to-env-file>
1616
### With Deno
1717

1818
```shell
19-
deno run --allow-read jsr:@wuespace/envdoc md .env.example
19+
deno run --allow-read jsr:@wuespace/envardoc md .env.example
2020
```
2121

2222
### With Docker
2323

2424
```shell
25-
docker run -it -v .:/data envdoc:latest md .env.example
25+
docker run -it -v .:/data ghcr.io/wuespace/envardoc:latest md .env.example
2626
```
2727

2828
## Env File Format

compose.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
services:
2-
envdoc:
3-
image: ghcr.io/wuespace/envdoc
2+
envardoc:
3+
image: ghcr.io/wuespace/envardoc
44
volumes:
55
- .:/data
66
command: docs .env.example

deno.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@wuespace/envdoc",
2+
"name": "@wuespace/envardoc",
33
"version": "0.1.0",
44
"description": "A documentation generator for .env files",
55
"license": "MIT",

main.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ if (import.meta.main) {
3131
});
3232

3333
await new Command()
34-
.name("envdoc")
34+
.name("envardoc")
3535
.version(metadata.version)
3636
.description(metadata.description)
3737
.meta('Deno', Deno.version.deno)

0 commit comments

Comments
 (0)