Commit ca16a62
committed
Promote the v2 README to README.md ahead of the first v2 beta
The repo front page still showed the v1 README while every release cut
from main is a v2 pre-release. Make the v2 README (README.v2.md) the
root README, with a banner that makes the status unmissable: alpha/beta
pre-release line, breaking changes between pre-releases, not for
production, v1.x is the stable line.
Retire the freeze machinery that kept README.md pinned at v1:
- the readme-v1-frozen pre-commit hook and the CI freeze check with its
override-readme-freeze label gate
- the --readme indirection in scripts/update_readme_snippets.py (the
script now reads README.md, its only remaining purpose)
- dead config that existed only for the split: the ruff hook exclude,
the pyproject ruff extend-exclude entries, the SKIP env in shared.yml,
and the examples/ trigger on the readme-snippets hook
Point pyproject's readme at README.md so PyPI keeps publishing the v2
long description, and add a release-checklist step to bump the version
examples in README.md and the docs when cutting a pre-release - the
tagged commit's README is what PyPI shows.1 parent e942d00 commit ca16a62
12 files changed
Lines changed: 84 additions & 2683 deletions
File tree
- .github/workflows
- examples
- scripts
- tests
- docs_src
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
31 | | - | |
32 | 30 | | |
33 | 31 | | |
34 | 32 | | |
| |||
42 | 40 | | |
43 | 41 | | |
44 | 42 | | |
45 | | - | |
46 | | - | |
47 | | - | |
48 | | - | |
49 | | - | |
50 | | - | |
51 | | - | |
52 | | - | |
53 | | - | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | 43 | | |
59 | 44 | | |
60 | 45 | | |
| |||
116 | 101 | | |
117 | 102 | | |
118 | 103 | | |
119 | | - | |
| 104 | + | |
120 | 105 | | |
121 | 106 | | |
122 | 107 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
45 | | - | |
46 | 45 | | |
47 | 46 | | |
48 | 47 | | |
| |||
55 | 54 | | |
56 | 55 | | |
57 | 56 | | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | 57 | | |
65 | 58 | | |
66 | 59 | | |
67 | 60 | | |
68 | | - | |
| 61 | + | |
69 | 62 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
15 | | - | |
16 | | - | |
| 15 | + | |
17 | 16 | | |
18 | 17 | | |
19 | 18 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
105 | 105 | | |
106 | 106 | | |
107 | 107 | | |
108 | | - | |
| 108 | + | |
109 | 109 | | |
110 | 110 | | |
111 | 111 | | |
| |||
0 commit comments