-
Notifications
You must be signed in to change notification settings - Fork 0
/
CHANGES.rst
437 lines (287 loc) · 12.9 KB
/
CHANGES.rst
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
.. this will be appended to README.rst
Changelog
=========
..
Feature request
.................
- Run coverage, upload results, and display badge
https://github.com/pytest-dev/pytest/blob/main/.github/workflows/test.yml
- Close stale issues after 14 days
https://github.com/pytest-dev/pytest/blob/main/.github/workflows/stale.yml
- Gracefully handle sigpipe error around validate entrypoint
https://github.com/pytest-dev/pytest/blob/main/src/_pytest/config/__init__.py#L190
Known regressions
..................
- strictyaml.scalar.Time does not exist. So field asTime can't be supported
- strictyaml has no automated tests
- strictyaml has no typing hint stubs. ignore_missing_imports
- ci/kit.yml in sdist Set output tag will be branch name, not tag name see ci/release.yml
Commit items for NEXT VERSION
..............................
.. scriv-start-here
.. _changes_1-3-0:
Version 1.3.0 — 2024-04-19
---------------------------
- ci: actions/setup-python remove option cache pip
- docs: add todo page
- ci(pre-commit): remove remove-intersphinx-inventory-files rtd needs docs/*.inv
- ci(tox): in docs, remove calls to build_inv and clean_inv
- docs(Makefile): build_inv and clean_inv use relative path
- docs: add links to pypi github sissues changelog chat
- docs: remove objects-python.txt too heavy. rtd needs docs/*.inv
- docs: enable sphinx extensions sphinx-external-toc-strict and myst-parser
- docs: requirement sphinx-external-toc --> sphinx-external-toc-strict
- fix: python-dateutil version pinned. Resolve dependency conflict
.. _changes_1-2-32:
Version 1.2.32 — 2024-04-17
---------------------------
- docs: generate intersphinx .inv files so only commit plain text files
- docs(Makefile): add targets build_inv inv2txt clean_inv
- docs: remove license.rst and sphinx-licenseinfo extension
- ci(tox): docs call make build_inv afterwards call make clean_inv
- ci(pre-commit): add remove-intersphinx-inventory-files
- ci(igor.py): harden _update_file so doesnt fail on nonexistent file
- ci(igor.py): from get_release_facts remove constants repo owner and github url
- ci(igor.py): do_quietly add arg, cwd
- refactor: semantic version separated into separate module
- feat: harden version_semantic handling against version str prepended by v
.. _changes_1-2-31:
Version 1.2.31 — 2024-04-08
---------------------------
- chore(test-coverage.yml): pass in tagged version to build tarball and whl
- test(test_logging_api.py): ci/cd env has both src and build/lib folders. 2x yaml file count
- docs(logging_api.py): class LoggingConfigYaml.__init__ missing one param
.. _changes_1-2-30:
Version 1.2.30 — 2024-04-08
---------------------------
- chore(test-coverage.yml): install logging-strict package before coverage run/report
.. _changes_1-2-29:
Version 1.2.29 — 2024-04-08
---------------------------
- chore: add codecov config file and workflow
- docs(README.rst): show codecov badge
.. _changes_1-2-28:
Version 1.2.28 — 2024-04-08
---------------------------
- docs(pyproject.toml): add homepage and documentation links. pypi.org show links
- docs: inventories updates
- docs: add threat model. Identify sewers; files which are targets for hackers
.. _changes_1-2-27:
Version 1.2.27 — 2024-04-05
---------------------------
- feat: table of contents (toc) seperated from Sphinx rst files
- docs: migrate sphinxcontrib-fulltoc --> sphinx_external_toc
- docs: in toc, link to license. Shows complete license
- docs: in toc, link to github and pypi.org
.. _changes_1-2-26:
Version 1.2.26 — 2024-04-04
---------------------------
- style: minimize usage of typing.Optional and typing.Union
- docs: favor intersphinx_mapping over extlinks. Minimize usage of extlinks
- docs: automodule in use, so module directive create a duplicate. Remove it
- docs: minimize/remove usage of external:[package]+ref:
.. _changes_1-2-25:
Version 1.2.25 — 2024-03-31
---------------------------
- docs(conf.py): intersphinx_mapping set a base url. In inv, paths become relative
- style: black decides add empty line between module header and imports
- chore(pre-commit): update dependency versions
- test: one unittest class name not CamelCase
.. _changes_1-2-24:
Version 1.2.24 — 2024-03-09
---------------------------
- docs: replace references to logging.config.handlers with logging.handlers
.. _changes_1-2-23:
Version 1.2.23 — 2024-03-09
---------------------------
- fix(setup.py): setuptools-scm configuration use setuptools-scm builtin handlers
- docs(setup.py): setuptools-scm docs are sparse. Explain as if to a six year old
.. _changes_1-2-22:
Version 1.2.22 — 2024-03-09
---------------------------
- docs(README.rst): Use raw.githubusercontent.com rather than github.com urls
- fix(README.rst): on rst to epub convert, github.com url showed page, not image
.. _changes_1-2-21:
Version 1.2.21 — 2024-03-02
---------------------------
- docs: resize and clean up validation animation gif
.. _changes_1-2-20:
Version 1.2.20 — 2024-03-02
---------------------------
- docs: add VHS tape. Demonstrate validation animated gif
.. _changes_1-2-19:
Version 1.2.19 — 2024-03-01
---------------------------
- docs: license badge not resolving. Change to github badge
.. _changes_1-2-18:
Version 1.2.18 — 2024-03-01
---------------------------
- docs(README.rst): a badge image url invalid tox -e docs fail
.. _changes_1-2-17:
Version 1.2.17 — 2024-03-01
---------------------------
- docs(README.rst): add badges
.. _changes_1-2-16:
Version 1.2.16 — 2024-03-01
---------------------------
- chore(setup.py): in clean_scheme stop prepending +clean causes readthedocs to fail
- chore(readthedocs): build html and pdf
.. _changes_1-2-15:
Version 1.2.15 — 2024-03-01
---------------------------
- chore(release.yml): jobs can be rerun, protect against publish duplicates
- chore(PyPi): server not configured with environment name
.. _changes_1-2-14:
Version 1.2.14 — 2024-03-01
---------------------------
- chore(TestPyPi): require tagged version, cannot use PEP 440 local versions
- chore(TestPyPi): server not configured with environment name
.. _changes_1-2-14:
Version 1.2.14 — 2024-02-29
---------------------------
- chore(release.yml): separate build from publish and release
- chore(release.yml): run on push, not create
- chore(release.yml): on push publish to test.pypi
- chore(release.yml): on tagged publish to pypi and github releases
- chore(release.yml): use node20 not node16
.. _changes_1-2-13:
Version 1.2.13 — 2024-02-29
---------------------------
- chore(release.yml): configure permissions id-token write
- chore(release.yml): configure environment for pypi
- chore(release.yml): if condition to only run tagged version
.. _changes_1-2-12:
Version 1.2.12 — 2024-02-29
---------------------------
- chore: actions/checkout with fetch-depth 0 gets branches and tags
- chore(release.yml): Publish package using pypa/gh-action-pypi-publish@release/v1
.. _changes_1-2-11:
Version 1.2.11 — 2024-02-28
---------------------------
- chore(ci): in release from on push --> on create tag
- chore(ci): in release fetch tags then get latest commit tag
- chore(ci): in codeql Initialize CodeQL with -> config -> paths and paths-ignore
- chore(ci): in codeql Initialize CodeQL with -> config -> paths folder ok file not ok
.. _changes_1-2-10:
Version 1.2.10 — 2024-02-28
---------------------------
- chore(ci): in testsuite do not download artifacts
- chore(ci): in release get tag name, not branch name. Prevent build create dev wheel
- chore(ci): in codeql limit to src folder tree. Include igor.py and ci/session.py
- chore(ci): in codeql remove from matrix javascript
.. _changes_1-2-9:
Version 1.2.9 — 2024-02-28
--------------------------
- test: tests maybe compiled before run. Cached and non-cached paths' differ
- chore(tox.ini): In lint, remove call, twine check dist/*
- chore: In testsuite and quality, remove prepare which uploaded dist/
- style: fix github repo url in requirements/*.in and docs/*.in
.. _changes_1-2-8:
Version 1.2.8 — 2024-02-27
--------------------------
- fix: build not occurring try to remove igor.py quietly call
.. _changes_1-2-7:
Version 1.2.7 — 2024-02-27
--------------------------
- chore: actions/download-artifact@v3 and actions/upload-artifact@v3 depreciated
- chore: be verbose listing tarballs and wheels
.. _changes_1-2-6:
Version 1.2.6 — 2024-02-27
--------------------------
- chore: move pre-commit to a tox.ini testenv
.. _changes_1-2-5:
Version 1.2.5 — 2024-02-27
--------------------------
- chore: gh workflow prepare dist/*
.. _changes_1-2-4:
Version 1.2.4 — 2024-02-27
--------------------------
- chore(tox.ini): try usedevelop off
- build(pyproject.toml): build as build environment dependency
.. _changes_1-2-3:
Version 1.2.3 — 2024-02-27
--------------------------
- chore(tox.ini): try building tagged version
- fix(release.yml): indention issue
.. _changes_1-2-2:
Version 1.2.2 — 2024-02-27
--------------------------
- fix(tox.ini): lint failing. In testenv build and install package
- chore(ci): release and kit were building develop wheels. Specify tag
.. _changes_1-2-1:
Version 1.2.1 — 2024-02-27
--------------------------
- chore(tox.ini): lint uses twine. Include dependency in dev.in
- chore(tox.ini): mypy needs requirements/mypy.pip
- chore(tox.ini): docs Sphinx warnings removed
- docs: sphinx warnings remove all
- fix(Makefile): REPO_OWNER repository name contains a hyphen
- chore(ci): trigger build kits and download release artifacts
- chore(gh workflows): remove attempt to support macos and windows
- chore(gh workflows): remove python-version pypy-3.8
.. _changes_1-2-0:
Version 1.2.0 — 2024-02-26
--------------------------
- feat: util.pep518_read for reading pyproject.toml sections
- docs(fix): util.pep518_read missing dependency of docs/conf.py
- fix: remove, as much as possible, mentions of package asz beside pyproject.toml sections
- chore(tox.ini): add test target
- chore(tox.ini): suppress noisy package build output
- chore(igor.py): add function do_quietly. suppress a commands noisy output
- docs: add scriv as a dependency
- docs: add logo logging-strict-logo.svg Cleaning svg breaks it. Remove systray-udisk2 logo
- docs: create sphinx object inventories to minimize sphinx build warnings
- docs: query sphinx object inventory using sphobjinv rather than sphinx.ext.intersphinx
- chore(ci): add .readthedocs.yml config file
- chore: add tox/ and cheats.txt to .gitignore
- chore(ci): add many .github/workflows
- chore(ci): add Makefile ci targets. add clean and sterile targets
.. _changes_1-1-0:
Version 1.1.0 — 2024-02-23
--------------------------
- docs: sphinx docs. user and code manual
- docs: Versioning explanation and howto
- feat: add tech_niques.stream_capture.CaptureOutput
- refactor: remove constants.RICH_OVERFLOW_OPTION_DEFAULT
- chore(igor.py): kind can now be a version str
.. _changes_1-0-1:
Version 1.0.1 — 2024-02-20
------------------------------------------------
- fix: retire public API function, setup_ui
- docs: Example code reflect correct API function calls
.. _changes_1-0-0:
Version 1.0.0 — 2024-02-20
------------------------------------------------
- style: isort and whitespace removal
- docs: correct module header dotted path
- docs: module exports update
- feat!: API contains public methods, enum, and exceptions
- docs: public API
- docs: example code for both UI and worker
- fix!: retire public API function, setup_worker
- fix: split setup_worker into two seperate steps. extract+validate and setup
.. _changes_0-1-1:
Version 0.1.1 — 2024-02-19
------------------------------------------------
In unittests, track down export of `*.worker.logging.config.yaml` to xdg user data dir,
rather than to a temp folder. To test, monitor ~/.local/share/[prog name] unlink
anything in that folder. Run, make coverage. The folder should remain empty
- test: prevent/redirect export of *.worker.logging.config.yaml to temp folder
.. _changes_0-1-0:
Version 0.1.0 — 2024-02-19
------------------------------------------------
- chore(setuptools-scm): semantic versioning. See constants.py, _version.py, and igor.py
- chore(isort): support extensions py and pyi
- chore(pre-commit): local repo bypasses hook. Once published local repo config unnecessary
- feat(pre-commit): hook validate-logging-strict-yaml
- feat: within a folder tree, use a pattern to extract package data files
- feat: validate logging.config yaml. Entrypoint logging_strict_validate_yaml
- feat(tech_niques): add context_locals
- feat(tech_niques): add logging_capture
- feat(tech_niques): add logging_redirect
- feat(tech_niques): add coverage_misbehaves. Detect if runner is coverage
- feat(tech_niques): add inspect a class interface
- feat: add two logging.config yaml files. One for app. One for worker
- test: add two dummy logging.config yaml files. One for app. One for worker
- feat(appdirs): package appdirs support. Chooses correct xdg folder
.. scriv-end-here