File tree 6 files changed +38
-12
lines changed
6 files changed +38
-12
lines changed Original file line number Diff line number Diff line change
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
Original file line number Diff line number Diff line change 1
1
FROM denoland/deno:2.1.3
2
2
3
- COPY . /envdoc
4
- WORKDIR /envdoc
3
+ COPY . /envardoc
4
+ WORKDIR /envardoc
5
5
6
6
RUN deno compile --allow-read main.ts
7
7
8
8
FROM gcr.io/distroless/cc-debian12
9
9
10
- COPY --from=0 /envdoc/envdoc /envdoc
10
+ COPY --from=0 /envardoc/envardoc /envardoc
11
11
12
12
WORKDIR /data
13
13
14
- ENTRYPOINT [ "/envdoc " ]
14
+ ENTRYPOINT [ "/envardoc " ]
Original file line number Diff line number Diff line change 1
- # envdoc
1
+ # envardoc
2
2
3
3
A documentation generator for .env files.
4
4
5
5
## Usage
6
6
7
7
``` shell
8
- envdoc < writer> < path-to-env-file>
8
+ envardoc < writer> < path-to-env-file>
9
9
```
10
10
11
11
### Writers
@@ -16,13 +16,13 @@ envdoc <writer> <path-to-env-file>
16
16
### With Deno
17
17
18
18
``` shell
19
- deno run --allow-read jsr:@wuespace/envdoc md .env.example
19
+ deno run --allow-read jsr:@wuespace/envardoc md .env.example
20
20
```
21
21
22
22
### With Docker
23
23
24
24
``` 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
26
26
```
27
27
28
28
## Env File Format
Original file line number Diff line number Diff line change 1
1
services :
2
- envdoc :
3
- image : ghcr.io/wuespace/envdoc
2
+ envardoc :
3
+ image : ghcr.io/wuespace/envardoc
4
4
volumes :
5
5
- .:/data
6
6
command : docs .env.example
Original file line number Diff line number Diff line change 1
1
{
2
- "name" : " @wuespace/envdoc " ,
2
+ "name" : " @wuespace/envardoc " ,
3
3
"version" : " 0.1.0" ,
4
4
"description" : " A documentation generator for .env files" ,
5
5
"license" : " MIT" ,
Original file line number Diff line number Diff line change @@ -31,7 +31,7 @@ if (import.meta.main) {
31
31
} ) ;
32
32
33
33
await new Command ( )
34
- . name ( "envdoc " )
34
+ . name ( "envardoc " )
35
35
. version ( metadata . version )
36
36
. description ( metadata . description )
37
37
. meta ( 'Deno' , Deno . version . deno )
You can’t perform that action at this time.
0 commit comments