rummikub-solver/Taskfile.yml at main · mjpieters/rummikub-solver · 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
# https://taskfile.dev

version: '3'

vars:
  PROJECT_NAME: "rummikub-solver"
  _PROJECT_UNDERSCORE: '{{.PROJECT_NAME | replace "-" "_"}}'

tasks:
  # utility tasks
  util:check_uv:
    desc: Check that UV is installed and print its version
    internal: true
    run: once
    preconditions:
      - sh: type "uv" &>/dev/null
        msg: Please install uv, see https://docs.astral.sh/uv/getting-started/installation/
    cmds:
      - uv --version

  # development
  dev:install-precommit:
    desc: Install pre-commit into local git checkout
    run: once
    status:
      - grep -q 'pre-commit\.com' .git/hooks/*
    cmds:
      - uv run pre-commit install

  dev:test:
    aliases:
      - test
    desc: Run tests
    run: always
    deps: [util:check_uv]
    cmds:
      - uv run pytest {{.CLI_ARGS}}

  dev:lint:renovate:
    desc: Lint the Renovate configuration file
    sources:
      - .github/renovate.json
    deps:
      - dev:install-precommit
    cmds:
      - pre-commit run --files .github/renovate.json renovate-config-validator

  dev:lint:code:
    desc: Lint the source code
    run: always
    deps: [util:check_uv]
    preconditions:
      - |
        uv lock --locked || {
          echo -e '\033[0;31mThe lockfile at `uv.lock` needs to be updated. To update the lockfile, run `task lock`\033[0m'.
          exit 1
        } >&2
    cmds:
      - uv run ruff format --check
      - uv run ruff check {{.CLI_ARGS}}
      - uv run pyright

  dev:lint:
    aliases:
      - lint
    desc: Runs linters
    deps:
      - dev:lint:code
      - dev:lint:renovate

  dev:format:
    aliases:
      - format
    desc: Runs formatters
    sources:
      - pyproject.toml
      - src/**
      - tests/**
    cmds:
      - uv run ruff format {{.CLI_ARGS}}

  dev:uv-lock:
    aliases:
      - lock
    desc: Updates the uv lock file
    deps: [util:check_uv]
    sources:
      - pyproject.toml
    generates:
      - pyproject.toml
      - uv.lock
    cmds:
      - uv lock

  # packaging
  dist:build:
    aliases:
      - dist
    desc: Build the distribution packages
    deps: [util:check_uv]
    sources:
      - uv.lock
      - pyproject.toml
      - README.md
      - LICENSE.txt
      - src/**
    generates:
      - dist/{{._PROJECT_UNDERSCORE}}-*.tar.gz
      - dist/{{._PROJECT_UNDERSCORE}}-*-py3-none-any.whl
    status:
      - test dist/{{._PROJECT_UNDERSCORE}}-$(uvx hatch version).tar.gz
      - test dist/{{._PROJECT_UNDERSCORE}}-$(uvx hatch version)-py3-none-any.whl
    env:
      UV_NO_SYNC: 1
      UV_FROZEN: 1
    cmds:
      - |
        echo 'Building distribution packages for {{.PROJECT_NAME}}'
        uv build {{.CLI_ARGS}}

  dist:clean:
    aliases:
      - clean
    desc: Remove built distribution packages
    dir: dist/
    sources:
      - '{{._PROJECT_UNDERSCORE}}-*.tar.gz'
      - '{{._PROJECT_UNDERSCORE}}-*-py3-none-any.whl'
    cmds:
      - for: sources
        cmd: rm {{.ITEM}}

  dist:publish:
    aliases:
      - publish
    desc: Publish package to PyPI
    deps: [util:check_uv, dist:build]
    env:
      UV_NO_SYNC: 1
      UV_FROZEN: 1
    cmds:
      - |
        LIB_VERSION=$(uvx hatch version)
        echo "Publishing distribution packages for {{.PROJECT_NAME}}, version ${LIB_VERSION}"
        uvx twine check "dist/{{._PROJECT_UNDERSCORE}}-${LIB_VERSION}.tar.gz" "dist/{{._PROJECT_UNDERSCORE}}-${LIB_VERSION}-py3-none-any.whl"
        uv publish {{.CLI_ARGS}}

  # documentation
  docs:serve:
    aliases:
      - preview
    desc: Live preview server for project documentation
    preconditions:
      - |
        uv sync --group docs --check 2> /dev/null || uv sync --group docs
    deps: [util:check_uv]
    cmds:
      - uv run mkdocs serve {{.CLI_ARGS}}

  docs:build:
    aliases:
      - docs
    desc: Build project documentation
    preconditions:
      - |
        uv sync --group docs --check 2> /dev/null || uv sync --group docs
    deps: [util:check_uv]
    cmds:
      - uv run mkdocs build {{.CLI_ARGS}}

  default:
    desc: Default task, runs linters and tests
    deps:
      - dev:lint
      - dev:test