osapi-io-taskfiles/docs.yml at main · osapi-io/osapi-io-taskfiles · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
version: "3"

tasks:
  yarn:install:
    desc: Setup Docusaurus locally
    cmds:
      - yarn install
    sources:
      - package.json
      - yarn.lock

  deps:
    desc: Install dependencies
    cmds:
      - npm install -g @redocly/cli

  build:
    desc: Build website
    deps:
      - yarn:install
    cmds:
      - yarn docusaurus build

  start:
    desc: Start website
    deps:
      - yarn:install
    vars:
      HOST: '{{default "localhost" .HOST}}'
      PORT: '{{default "3001" .PORT}}'
    cmds:
      - yarn docusaurus start --no-open --host={{.HOST}} --port={{.PORT}}

  serve:
    desc: Preview website
    deps:
      - yarn:install
    vars:
      HOST: '{{default "localhost" .HOST}}'
      PORT: '{{default "3001" .PORT}}'
    cmds:
      - yarn docusaurus serve --no-open --host={{.HOST}} --port={{.PORT}}

  clean:
    desc: Clean temp directories
    cmds:
      - rm -rf ./build

  bump:
    desc: Create a new documentation version
    vars:
      VERSION: '{{.VERSION}}'
    cmds:
      - yarn docusaurus docs:version {{.VERSION}}
    requires:
      vars:
        - VERSION

  deploy:
    desc: Build and deploy Docusaurus
    summary: Requires GIT_USER and GIT_PASS envs to be previous set
    cmds:
      - yarn docusaurus deploy

  fmt:
    desc: Reformat files whose formatting differs from `prettier`
    deps:
      - yarn:install
    cmds:
      - yarn prettier docs --write --config prettier.config.js --ignore-path .prettierignore

  fmt:check:
    desc: Check files whose formatting differs from `prettier`
    deps:
      - yarn:install
    cmds:
      - yarn prettier docs --check --config prettier.config.js

  generate:
    desc:  Generates OpenAPI docs in MDX file format and sidebar.ts
    deps:
      - yarn:install
    cmds:
      - rm -rf docs/gen/
      - yarn docusaurus gen-api-docs all