@rt-tools/agent-kit 0.10.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/assets/checks/check-file-size.mjs +19 -4
- package/assets/checks/check-state-next.mjs +202 -0
- package/assets/checks/check-states.mjs +142 -0
- package/assets/checks/check-turn-map.mjs +146 -0
- package/assets/checks/rt-kit-checks.config.mjs +16 -2
- package/assets/defaults/project.sh +67 -7
- package/assets/defaults/turn-map.md +48 -0
- package/assets/hooks/browser-device-id.sh +2 -0
- package/assets/hooks/browser-guard-device-id.sh +5 -1
- package/assets/hooks/browser-guard-no-asking.sh +5 -1
- package/assets/hooks/browser-guard-no-listing.sh +2 -0
- package/assets/hooks/browser-guard-no-other-drivers.sh +7 -3
- package/assets/hooks/browser-guard-require-select.sh +6 -2
- package/assets/hooks/claim-guard.sh +5 -1
- package/assets/hooks/commit-msg.sh +2 -0
- package/assets/hooks/conscience-guard.sh +5 -1
- package/assets/hooks/constitution-index.sh +2 -0
- package/assets/hooks/dev-server-guard.sh +7 -3
- package/assets/hooks/dispatch.sh +69 -0
- package/assets/hooks/docs-guard.sh +8 -4
- package/assets/hooks/exam-guard.sh +7 -3
- package/assets/hooks/git-guard-delivery-signature.sh +2 -0
- package/assets/hooks/git-guard-delivery.sh +39 -5
- package/assets/hooks/git-guard-main.sh +8 -4
- package/assets/hooks/git-guard-push-tests.sh +8 -4
- package/assets/hooks/glossary-load.sh +2 -0
- package/assets/hooks/grill-gate.sh +6 -2
- package/assets/hooks/handoff-entry-guard.sh +6 -2
- package/assets/hooks/handoff-write.sh +124 -0
- package/assets/hooks/hook-input.sh +54 -0
- package/assets/hooks/lint-after-edit.sh +7 -3
- package/assets/hooks/observe.sh +2 -0
- package/assets/hooks/postmortem-guard.sh +5 -1
- package/assets/hooks/proposal-guard.sh +5 -1
- package/assets/hooks/prose-style-guard.sh +7 -3
- package/assets/hooks/qa-dataid-guard.sh +6 -2
- package/assets/hooks/rerun-guard.sh +7 -3
- package/assets/hooks/reuse-first-guard.sh +7 -3
- package/assets/hooks/roles.sh +2 -0
- package/assets/hooks/rule-article.sh +99 -0
- package/assets/hooks/skill-gate-layers.sh +2 -0
- package/assets/hooks/skill-gate-rearm.sh +5 -1
- package/assets/hooks/skill-gate.sh +25 -2
- package/assets/hooks/skill-loaded.sh +5 -1
- package/assets/hooks/sql-guard-parse.sh +2 -0
- package/assets/hooks/sql-guard-request.sh +4 -1
- package/assets/hooks/sql-guard-target.sh +2 -0
- package/assets/hooks/sql-guard-write.sh +2 -0
- package/assets/hooks/sql-guard.sh +6 -2
- package/assets/hooks/task-context-load.sh +2 -0
- package/assets/hooks/task-flow-guard.sh +8 -4
- package/assets/hooks/turn-entry-load.sh +62 -0
- package/assets/hooks/turn-exit-guard.sh +44 -17
- package/assets/hooks/utf8.sh +35 -0
- package/assets/hooks/waiting-turn-guard.sh +5 -1
- package/assets/hooks/window-fill-guard.sh +37 -5
- package/assets/laws/work-conduct.md +34 -9
- package/assets/patterns/dependencies-upgrade.md +1 -1
- package/assets/patterns/doc-style-write.md +3 -3
- package/assets/patterns/git-workflow-commit.azure.md +2 -202
- package/assets/patterns/git-workflow-commit.github.md +2 -258
- package/assets/patterns/git-workflow-commit.gitlab.md +1 -217
- package/assets/patterns/git-workflow-docker.md +3 -3
- package/assets/patterns/git-workflow-merge.md +3 -2
- package/assets/patterns/git-workflow-migration.md +3 -3
- package/assets/patterns/git-workflow-pr.azure.md +224 -0
- package/assets/patterns/git-workflow-pr.github.md +280 -0
- package/assets/patterns/git-workflow-pr.gitlab.md +240 -0
- package/assets/patterns/git-workflow-restart.md +3 -3
- package/assets/patterns/git-workflow-secrets.md +3 -3
- package/assets/patterns/task-flow-archive.md +193 -0
- package/assets/patterns/task-flow-close.md +11 -160
- package/assets/patterns/task-flow-handoff.md +22 -4
- package/assets/patterns/task-flow-resume.md +6 -0
- package/assets/patterns/task-flow-start.md +41 -0
- package/assets/patterns/turn-entry-map.md +81 -0
- package/assets/pitfalls/doc-style.md +80 -0
- package/assets/pitfalls/git-workflow.azure.md +50 -0
- package/assets/pitfalls/git-workflow.github.md +78 -0
- package/assets/pitfalls/git-workflow.gitlab.md +49 -0
- package/assets/pitfalls/spec-driven.md +36 -0
- package/assets/pitfalls/styling-bem.md +45 -0
- package/assets/pitfalls/task-flow.md +62 -0
- package/assets/pitfalls/testing.md +70 -0
- package/assets/rules/deploy-flow.azure.md +106 -0
- package/assets/rules/deploy-flow.github.md +113 -0
- package/assets/rules/deploy-flow.gitlab.md +108 -0
- package/assets/rules/doc-style.md +25 -76
- package/assets/rules/git-workflow.azure.md +6 -92
- package/assets/rules/git-workflow.github.md +14 -127
- package/assets/rules/git-workflow.gitlab.md +6 -93
- package/assets/rules/spec-driven.md +39 -30
- package/assets/rules/styling-bem.md +20 -39
- package/assets/rules/task-flow.md +17 -186
- package/assets/rules/testing.md +3 -64
- package/assets/rules/turn-conduct.md +206 -0
- package/assets/rules/turn-entry.md +93 -0
- package/assets/rules/typescript-conventions.md +15 -0
- package/assets/skills/agent-kit.md +35 -12
- package/assets/templates/pitfalls.md +10 -0
- package/assets/templates/rule.md +5 -3
- package/lib/assets.d.ts.map +1 -1
- package/lib/assets.js +6 -1
- package/lib/assets.js.map +1 -1
- package/lib/cargo.d.ts +42 -0
- package/lib/cargo.d.ts.map +1 -1
- package/lib/cargo.js +2 -0
- package/lib/cargo.js.map +1 -1
- package/lib/cascade.d.ts.map +1 -1
- package/lib/cascade.js +19 -1
- package/lib/cascade.js.map +1 -1
- package/lib/commands.d.ts.map +1 -1
- package/lib/commands.js +65 -4
- package/lib/commands.js.map +1 -1
- package/lib/config.d.ts +16 -1
- package/lib/config.d.ts.map +1 -1
- package/lib/config.js +8 -0
- package/lib/config.js.map +1 -1
- package/lib/hooks-map.d.ts +13 -0
- package/lib/hooks-map.d.ts.map +1 -1
- package/lib/hooks-map.js +33 -1
- package/lib/hooks-map.js.map +1 -1
- package/lib/observations.d.ts +35 -1
- package/lib/observations.d.ts.map +1 -1
- package/lib/observations.js +14 -2
- package/lib/observations.js.map +1 -1
- package/lib/ship.d.ts +2 -0
- package/lib/ship.d.ts.map +1 -1
- package/lib/ship.js +2 -0
- package/lib/ship.js.map +1 -1
- package/lib/thresholds.d.ts +49 -0
- package/lib/thresholds.d.ts.map +1 -0
- package/lib/thresholds.js +151 -0
- package/lib/thresholds.js.map +1 -0
- package/package.json +1 -1
- package/rt-tools-agent-kit-0.12.0.tgz +0 -0
- package/assets/commands/agent-kit-digest.md +0 -88
- package/assets/commands/rules-review.md +0 -98
- package/rt-tools-agent-kit-0.10.0.tgz +0 -0
|
@@ -0,0 +1,280 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: git-workflow-pr
|
|
3
|
+
kind: pattern
|
|
4
|
+
rule: git-workflow
|
|
5
|
+
description: Паттерн правила git-workflow. Брать на открытие PR и всё, что с ним связано, — формат заголовка, черновик и его снятие, строка связи с задачей, ревьювер, исполнитель и метки, образец тела с разделом об оставшемся шаге, чтение состояния PR, перевод задачи в колонку разбора, чеклист проверок до снятия черновика. Не брать на заведение задачи, ветки и коммит — это паттерн git-workflow-commit.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Заявка на слияние
|
|
9
|
+
|
|
10
|
+
Паттерн правила `git-workflow`. Что при этом должно быть верно — закон
|
|
11
|
+
`docs/constitution/delivery.md`. Заведение задачи, ветки и коммит — паттерн
|
|
12
|
+
`git-workflow-commit`.
|
|
13
|
+
|
|
14
|
+
## Когда брать
|
|
15
|
+
|
|
16
|
+
- Открывается PR по готовой ветке.
|
|
17
|
+
- Правится заголовок, тело или метки уже открытого PR.
|
|
18
|
+
- Снимается черновик, и работа отдаётся на разбор.
|
|
19
|
+
- Читается состояние PR перед тем, как что-либо о нём сказать владельцу.
|
|
20
|
+
|
|
21
|
+
## Номер задачи стоит в её заголовке и в заголовке PR
|
|
22
|
+
|
|
23
|
+
Форма одна на оба — `[<КЛЮЧ>-<номер>] <текст>`. Номер стоит в самом заголовке, а не только в
|
|
24
|
+
теле: в списке PR тела не видно, а в списке задач номер иначе приходится искать глазами по
|
|
25
|
+
колонке слева. Тот же номер несёт и имя ветки — `<КЛЮЧ>-<номер>-<короткий-slug>`, — поэтому
|
|
26
|
+
задача, ветка и PR читаются как одно.
|
|
27
|
+
|
|
28
|
+
Задача говорит, что не так; PR тем же номером отчитывается, что сделано:
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
задача [<КЛЮЧ>-86] Пустой MAIL_OWNER — письма владельцу не уходят молча
|
|
32
|
+
PR [<КЛЮЧ>-86] Письмо владельцу с незаполненным адресом попадает в логи
|
|
33
|
+
|
|
34
|
+
задача [<КЛЮЧ>-101] Вернуть оверлей загрузки таблицы и включить stylelint гейтом
|
|
35
|
+
PR [<КЛЮЧ>-101] Stylelint включён гейтом
|
|
36
|
+
|
|
37
|
+
задача [<КЛЮЧ>-212] Сайт не собирается: компонентам кита проставлен префикс приложения вместо своего
|
|
38
|
+
PR [<КЛЮЧ>-212] Виджет переписки зовёт кит его собственными именами
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Инфинитив из задачи в заголовок PR не переносится: «исправить» становится «исправлено»,
|
|
42
|
+
«вернуть» — «возвращено», «добавить» — «добавлено».
|
|
43
|
+
|
|
44
|
+
Номер в заголовке обязан совпасть с номером ветки: гард поставки сверяет их до отправки
|
|
45
|
+
команды, а сверка очереди — у каждого открытого PR.
|
|
46
|
+
|
|
47
|
+
Тип и область — `fix(site):`, `docs(common):` — в заголовок PR не идут: это формат заголовка
|
|
48
|
+
коммита, и там его сверяет `commitlint`. В списке PR он занимает место, ничего не добавляя:
|
|
49
|
+
род правки и область уже видны метками.
|
|
50
|
+
|
|
51
|
+
## Не готовое к слиянию открывается черновиком
|
|
52
|
+
|
|
53
|
+
Правка кода отдаётся человеку открытым PR: запушенная ветка ему не показывается нигде. Открытый
|
|
54
|
+
PR при этом читается как приглашение влить, поэтому у незаконченной работы он открывается
|
|
55
|
+
черновиком — кнопку слияния у черновика хостинг блокирует сам:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
GH_TOKEN="$TOKEN" gh pr create --draft --title '[<КЛЮЧ>-86] …' --body-file тело.md
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Черновиком идёт всё, что ждёт прогона конвейера, доработки или ответа на вопрос. Вопрос
|
|
62
|
+
задаётся в самом PR, а не остаётся в голове исполнителя: человек читает PR, а не переписку
|
|
63
|
+
захода.
|
|
64
|
+
|
|
65
|
+
Снимается черновик отдельным вызовом, и это тот самый ход, которым исполнитель говорит, что
|
|
66
|
+
решение готово:
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
GH_TOKEN="$TOKEN" gh pr ready 86
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
До снятия молчание исполнителя значит «ещё не готово», после — «можно вливать». Снятие
|
|
73
|
+
черновика и просьба влить идут одним ходом: снятый черновик, о котором человеку не сказали,
|
|
74
|
+
ждёт разбора ровно так же, как не снятый.
|
|
75
|
+
|
|
76
|
+
## PR прикрепляется к задаче
|
|
77
|
+
|
|
78
|
+
Тело начинается со строки связи — по ней на борде заполняется поле «Linked pull requests».
|
|
79
|
+
Ревьювер, исполнитель и метки задаются той же командой, и PR без них не открывается:
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
GH_TOKEN="$TOKEN" gh pr create --title '[<КЛЮЧ>-86] Письмо владельцу с незаполненным адресом попадает в логи' \
|
|
83
|
+
--reviewer <владелец> --assignee <бот> --label bug --label area:api \
|
|
84
|
+
--body 'Closes #86
|
|
85
|
+
|
|
86
|
+
…'
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
Ревьювер — всегда владелец: без запроса разбора PR не показывается ему в очереди. Исполнитель —
|
|
90
|
+
та же учётная запись, от которой идёт машинная работа. Метки берутся у задачи целиком — и род
|
|
91
|
+
правки, и все её области; читаются они у задачи, а не выбираются по памяти:
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
/opt/homebrew/bin/gh issue view 86 --json labels --jq '.labels | map(.name) | join(",")'
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Строка `Closes #<номер>` обязательна: без неё PR не прикрепляется к задаче, и сверка очереди
|
|
98
|
+
это находит. Она же и означает, что задача закрывается целиком — половину задачи одним PR не
|
|
99
|
+
выкатывают: у задачи одна ветка, и работа, которая в неё не влезает, делится на задачи до
|
|
100
|
+
того, как ветка заводится.
|
|
101
|
+
|
|
102
|
+
У уже открытого PR то же ставится тремя вызовами REST. `gh pr edit` здесь не годится: он
|
|
103
|
+
запрашивает карточки Projects (classic), получает отказ о снятом API и до правки не доходит.
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
GH=/opt/homebrew/bin/gh
|
|
107
|
+
REPO=<владелец>/<репозиторий>
|
|
108
|
+
|
|
109
|
+
$GH api -X POST "repos/$REPO/issues/205/labels" -f 'labels[]=bug' -f 'labels[]=area:api'
|
|
110
|
+
$GH api -X POST "repos/$REPO/issues/205/assignees" -f 'assignees[]=<бот>'
|
|
111
|
+
$GH api -X POST "repos/$REPO/pulls/205/requested_reviewers" -f 'reviewers[]=<владелец>'
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Тем же вызовом правится и само тело: `-f body=` переписывает его целиком, поэтому строка
|
|
115
|
+
`Closes #<номер>` пишется заново вместе с остальным текстом.
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
$GH api -X PATCH "repos/$REPO/pulls/205" -f body="$(cat тело.md)"
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Тело перечитывается всякий раз, когда в ветку что-то влилось после публикации: PR
|
|
122
|
+
утверждает про дерево, а дерево с тех пор изменилось.
|
|
123
|
+
|
|
124
|
+
## Образец тела PR
|
|
125
|
+
|
|
126
|
+
Четыре раздела, и порядок между ними один: строка связи, что сделано, чем подтверждено,
|
|
127
|
+
оставшийся шаг. Раздел, которому нечего сказать, пишется словами — пустой заголовок и снятый
|
|
128
|
+
заголовок читаются одинаково, а значат разное.
|
|
129
|
+
|
|
130
|
+
```markdown
|
|
131
|
+
Closes #86
|
|
132
|
+
|
|
133
|
+
## Что сделано
|
|
134
|
+
|
|
135
|
+
- <правка, названная тем, что она меняет для читателя, а не тем, какие файлы задела>
|
|
136
|
+
|
|
137
|
+
## Чем подтверждено
|
|
138
|
+
|
|
139
|
+
- <проверка>: <её вывод одной строкой>
|
|
140
|
+
- Не гонялось: <что в набор не вошло и почему>
|
|
141
|
+
|
|
142
|
+
## Оставшийся шаг
|
|
143
|
+
|
|
144
|
+
После одобрения ветка получает ещё один коммит — разбор папки задачи, — и только потом
|
|
145
|
+
вливается. До этого коммита вливать рано: папка уедет в главную ветку неразобранной.
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Раздел «Оставшийся шаг» стоит последним и переписывается тем же вызовом, что и остальное тело,
|
|
149
|
+
— в тот ход, которым папка разбирается и снимается черновик:
|
|
150
|
+
|
|
151
|
+
```markdown
|
|
152
|
+
## Оставшийся шаг
|
|
153
|
+
|
|
154
|
+
Не осталось: папка задачи разобрана коммитом `<sha>`, черновик снят. Можно вливать.
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Стоит он там потому, что решение о слиянии принимается на этой странице, а не в переписке:
|
|
158
|
+
сказанное владельцу вслух живёт до следующей реплики, а тело лежит у самой кнопки. Одно другого
|
|
159
|
+
не отменяет — порядок обоих сообщений владельцу описывает паттерн закрытия работы.
|
|
160
|
+
|
|
161
|
+
Проверить тело машиной нечем: ни одна сверка его не читает, а хостинг спрашивает только про
|
|
162
|
+
заголовок. Держится образец тем, кто пишет тело, — как и слова вслух.
|
|
163
|
+
|
|
164
|
+
## Состояние PR читается, а не додумывается
|
|
165
|
+
|
|
166
|
+
Вызовы, которыми ставятся ревьювер, метки и исполнитель, отвечают нулевым кодом и тогда, когда
|
|
167
|
+
ничего не сделали: запрос разбора на автора PR GitHub молча выбрасывает. Поэтому после них PR
|
|
168
|
+
перечитывают:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
# Ключи латиницей: кириллический ключ без кавычек `jq` не разбирает и падает на нём
|
|
172
|
+
$GH api "repos/$REPO/pulls/321" \
|
|
173
|
+
--jq '{author: .user.login, reviewers: [.requested_reviewers[].login], labels: [.labels[].name]}'
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
Автор здесь — `<бот>`. Если им оказался владелец, ревьювера у PR не будет вовсе:
|
|
177
|
+
назначить автора ревьювером нельзя, а отказа на такой запрос не приходит. Владельцу называют
|
|
178
|
+
то, что прочитали, а не то, что заказывали.
|
|
179
|
+
|
|
180
|
+
Учётная запись, из-под которой пришлось пушить, в этот вызов не переносится: пуш и авторство
|
|
181
|
+
PR выбираются отдельно, и `GH_TOKEN` для публикации — всегда токен бота.
|
|
182
|
+
|
|
183
|
+
Перечитывают его и по времени, а не только после вызовов, которые молча ничего не сделали:
|
|
184
|
+
состояние PR читается перед тем, как что-либо о нём сказать. Между «прогон зелёный» и следующей
|
|
185
|
+
фразой владелец успевает влить PR, и всё сказанное о нём после этого — про вчерашний день. Так
|
|
186
|
+
владельцу и было предложено влить то, что он влил часом раньше.
|
|
187
|
+
|
|
188
|
+
Открытый PR означает, что задача ждёт разбора, — колонка переставляется тем же движением:
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
npm run task:move -- 86 in-review
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Голым GraphQL по идентификаторам проекта, элемента и варианта поля это не пишется: команда
|
|
195
|
+
знает их сама, а собранный по памяти запрос молча ставит не ту колонку — отказа у борды на
|
|
196
|
+
это нет.
|
|
197
|
+
|
|
198
|
+
## Что проверяется до публикации PR
|
|
199
|
+
|
|
200
|
+
Проверок на самом PR нет: выкатка запускается пушем в главную ветку, и до мержа никто не
|
|
201
|
+
гоняет ничего. Линтеры, юниты и сценарии хуков снимает гейт пуша — ниже то, чего он не знает.
|
|
202
|
+
|
|
203
|
+
1. **Главная ветка влита в эту ветку** — `git fetch origin && git merge origin/main`.
|
|
204
|
+
Свежесть основания между ветками одного захода не наследуется: вторая и третья ветка
|
|
205
|
+
отводятся после своего `fetch`, а не от ссылки, подтянутой под первую. Пока идёт работа,
|
|
206
|
+
главная уходит вперёд — чаще всего собственным PR того же исполнителя, влитым час
|
|
207
|
+
назад.
|
|
208
|
+
Всё, что проверяется ниже, проверяется от этого основания: PR с разошедшейся ветки
|
|
209
|
+
показывает ревьюверу правку вперемешку с чужой. Порядок и разбор конфликта — паттерн
|
|
210
|
+
`git-workflow-merge`.
|
|
211
|
+
2. **В ветке только та правка, за которой её заводили** — `git diff main...HEAD --stat`. Чужой
|
|
212
|
+
домен в списке файлов означает, что правка расползлась, и её надо вернуть в свои границы.
|
|
213
|
+
3. **Ни мока, ни подменённого ответа, ни отладочной строки** — `git diff main...HEAD` читается
|
|
214
|
+
целиком, а не по именам файлов. На прод они уезжают молча и портят настоящие данные.
|
|
215
|
+
4. **Документ едет тем же коммитом.** Пару называет `docs-guard`, но спек домена и правку его
|
|
216
|
+
поведения он не знает — это остаётся за автором.
|
|
217
|
+
5. **Проверки текстов и раскладки зелёные** — те, что дерево завело в `tools/`: сверка
|
|
218
|
+
сценариев с тестами, путей в документах, раскладки либ, повторов и классов без правила.
|
|
219
|
+
Какие именно есть здесь — `implementation.md` правила.
|
|
220
|
+
6. **Все приложения дерева собираются** — `nx build` по каждому. Гейт пуша сборку не гоняет:
|
|
221
|
+
она длиннее всего, что он успевает сделать между командой и пушем.
|
|
222
|
+
7. **Видимый текст заведён во всех локалях перевода** — тестом полноты словарей, если дерево
|
|
223
|
+
переводится.
|
|
224
|
+
8. **Правка вёрстки подтверждена замером**, а не взглядом, и снята при узком экране — паттерн
|
|
225
|
+
`browser-verification-measure`.
|
|
226
|
+
9. **Правка разметки публичного сайта проверена на прод-сборке по всем локалям перевода** — паттерн
|
|
227
|
+
`seo-verify`.
|
|
228
|
+
10. **Тело PR собрано по образцу** — начинается строкой `Closes #<номер>`, несёт разделы «Что
|
|
229
|
+
сделано», «Чем подтверждено» и «Оставшийся шаг», а метки, ревьювер и исполнитель стоят.
|
|
230
|
+
Раздел оставшегося шага к этому моменту говорит, что шагов не осталось: черновик снимается
|
|
231
|
+
после разбора папки, а не до него.
|
|
232
|
+
11. **Заголовок PR несёт номер задачи и называет её сделанной:** `[<КЛЮЧ>-<номер>] <Что сделано>`,
|
|
233
|
+
тем же номером, что стоит у задачи и в имени ветки. Инфинитив из задачи в него не
|
|
234
|
+
переносится, тип и область коммита — тоже.
|
|
235
|
+
12. **Очередь работ сходится** — `npm run check:board`. Задача на борде, с исполнителем и
|
|
236
|
+
номером в заголовке; PR один на задачу, и закрывает он её целиком.
|
|
237
|
+
13. **Состояние PR прочитано, а не выведено из кодов возврата** — автор `<бот>`,
|
|
238
|
+
ревьювер — владелец, метки те же, что у задачи. Владельцу называют прочитанное.
|
|
239
|
+
14. **Набор взят из файла конвейера, а не собран по памяти.** Гейт пуша заведомо уже: он стоит
|
|
240
|
+
между командой и пушем, и всё, что дольше секунд, из него вынесено. Что гоняет конвейер,
|
|
241
|
+
написано в его файле — этот список и повторяется локально; зелёный гейт полнотой набора не
|
|
242
|
+
является.
|
|
243
|
+
15. **Набор пересмотрен после вливания главной ветки.** Он выбирается по тому, что ветка везёт
|
|
244
|
+
теперь, а не по тому, что правил автор. Ветка, не тронувшая ни строки показа, прогоняет
|
|
245
|
+
снимки витрин: с момента вливания их гоняет конвейер на её коде, и красное придёт на её
|
|
246
|
+
PR.
|
|
247
|
+
|
|
248
|
+
Список этот — про снятие черновика, а не про его открытие. Черновиком PR открывается раньше:
|
|
249
|
+
пока работа идёт, человеку показывают то, что уже есть, вместе с тем, чего ещё нет. Пункты 1–15
|
|
250
|
+
проходятся перед `gh pr ready`, и невыполненный пункт означает, что черновик не снимается, — а
|
|
251
|
+
не то, что PR не открывается.
|
|
252
|
+
|
|
253
|
+
Сразу после публикации задача переставляется в разбор — `npm run task:move -- <номер>
|
|
254
|
+
in-review`, — и `npm run check:board` прогоняется ещё раз: до открытия PR колонку он не судит,
|
|
255
|
+
а после открытия расхождение видит.
|
|
256
|
+
|
|
257
|
+
Сделанное рассуждением и сделанное замером в теле PR разводятся прямо: непроверенное,
|
|
258
|
+
названное проверенным, ревьювер принимает за проверенное.
|
|
259
|
+
|
|
260
|
+
**Раздел «Чем подтверждено» называет и то, что не гонялось.** Список одного прогнанного
|
|
261
|
+
неотличим от полного набора, и ревьювер по нему решает, что можно не перепроверять. Цена ошибки
|
|
262
|
+
здесь не красный конвейер, а доверие к разделу: однажды прочитанный как полнота, дальше он
|
|
263
|
+
перепроверяется весь.
|
|
264
|
+
|
|
265
|
+
## Частые промахи
|
|
266
|
+
|
|
267
|
+
Промахи про заведение задачи, ветку и коммит — паттерн
|
|
268
|
+
`git-workflow-commit`.
|
|
269
|
+
|
|
270
|
+
- Второй строкой `Closes` в одном PR задача больше не закрывается: две задачи в одной ветке
|
|
271
|
+
откатываются только вместе. Либо это одна задача — и вторая поглощается, — либо две ветки.
|
|
272
|
+
- Половина задачи, уехавшая своим PR, тоже промах: тело такого PR начинается со слов «Часть
|
|
273
|
+
#<номер>» вместо `Closes`, задача остаётся открытой, и после отката видно её целой. Работа,
|
|
274
|
+
которая в одну ветку не влезает, делится на задачи до того, как ветка заводится.
|
|
275
|
+
- PR открыт без ревьювера: он не попадает во входящие владельца вовсе, и очередь стоит,
|
|
276
|
+
выглядя работающей. Так шестнадцать PR ждали разбора, которого никто не запрашивал.
|
|
277
|
+
- Метки поставлены по названию PR, а не прочитаны у задачи: область теряется, и по борде не
|
|
278
|
+
видно, что правка задела ещё и сайт.
|
|
279
|
+
- Задача закрыта не полностью, а метки перенесены целиком: тикет остаётся открытым, и это
|
|
280
|
+
говорится в теле PR, а не подразумевается строкой `Closes`.
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: git-workflow-pr
|
|
3
|
+
kind: pattern
|
|
4
|
+
rule: git-workflow
|
|
5
|
+
description: Паттерн правила git-workflow. Брать на открытие MR и всё, что с ним связано, — формат заголовка, черновик и его снятие, строка связи с задачей, ревьювер и метки, образец описания с разделом об оставшемся шаге, чтение состояния MR, перевод задачи в список разбора, чеклист проверок до снятия черновика. Не брать на заведение задачи, ветки и коммит — это паттерн git-workflow-commit.
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
# Заявка на слияние
|
|
9
|
+
|
|
10
|
+
Паттерн правила `git-workflow`. Что при этом должно быть верно — закон
|
|
11
|
+
`docs/constitution/delivery.md`. Заведение задачи, ветки и коммит — паттерн
|
|
12
|
+
`git-workflow-commit`.
|
|
13
|
+
|
|
14
|
+
## Когда брать
|
|
15
|
+
|
|
16
|
+
- Открывается MR по готовой ветке.
|
|
17
|
+
- Правится заголовок, тело или метки уже открытого MR.
|
|
18
|
+
- Снимается черновик, и работа отдаётся на разбор.
|
|
19
|
+
- Читается состояние MR перед тем, как что-либо о нём сказать владельцу.
|
|
20
|
+
|
|
21
|
+
## Номер задачи стоит в её заголовке и в заголовке MR
|
|
22
|
+
|
|
23
|
+
Форма одна на оба — `[<КЛЮЧ>-<номер>] <текст>`. Номер стоит в самом заголовке, а не только в
|
|
24
|
+
теле: в списке MR тела не видно, а в списке задач номер иначе приходится искать глазами. Тот же
|
|
25
|
+
номер несёт и имя ветки, поэтому задача, ветка и MR читаются как одно.
|
|
26
|
+
|
|
27
|
+
Задача говорит, что не так; MR тем же номером отчитывается, что сделано:
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
задача [<КЛЮЧ>-86] Пустой адрес владельца — письма не уходят молча
|
|
31
|
+
MR [<КЛЮЧ>-86] Письмо владельцу с незаполненным адресом попадает в логи
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
Инфинитив из задачи в заголовок MR не переносится: «исправить» становится «исправлено»,
|
|
35
|
+
«вернуть» — «возвращено», «добавить» — «добавлено».
|
|
36
|
+
|
|
37
|
+
Тип и область — `fix(site):`, `docs(common):` — в заголовок MR не идут: это формат заголовка
|
|
38
|
+
коммита, и там его сверяет `commitlint`. В списке MR он занимает место, ничего не добавляя:
|
|
39
|
+
род правки и область уже видны метками.
|
|
40
|
+
|
|
41
|
+
## Не готовое к слиянию открывается черновиком
|
|
42
|
+
|
|
43
|
+
Правка кода отдаётся человеку открытым MR: запушенная ветка ему не показывается нигде. Открытый
|
|
44
|
+
MR при этом читается как приглашение влить, поэтому у незаконченной работы он открывается
|
|
45
|
+
черновиком — кнопку слияния у черновика хостинг блокирует сам:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
GITLAB_TOKEN="$TOKEN" glab mr create --draft --title '[<КЛЮЧ>-86] …' --description "$(cat тело.md)"
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
Признак черновика здесь — приставка `Draft:` в заголовке MR, и правится он вместе с ним:
|
|
52
|
+
переписав заголовок вручную, черновик снимают, не заметив этого.
|
|
53
|
+
|
|
54
|
+
Черновиком идёт всё, что ждёт прогона конвейера, доработки или ответа на вопрос. Вопрос
|
|
55
|
+
задаётся в самом MR, а не остаётся в голове исполнителя: человек читает MR, а не переписку
|
|
56
|
+
захода.
|
|
57
|
+
|
|
58
|
+
Снимается черновик отдельным вызовом, и это тот самый ход, которым исполнитель говорит, что
|
|
59
|
+
решение готово:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
GITLAB_TOKEN="$TOKEN" glab mr update 86 --ready
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
До снятия молчание исполнителя значит «ещё не готово», после — «можно вливать». Снятие
|
|
66
|
+
черновика и просьба влить идут одним ходом: снятый черновик, о котором человеку не сказали,
|
|
67
|
+
ждёт разбора ровно так же, как не снятый.
|
|
68
|
+
|
|
69
|
+
## MR прикрепляется к задаче
|
|
70
|
+
|
|
71
|
+
Описание начинается со строки связи. Ревьювер, исполнитель и метки задаются той же командой, и
|
|
72
|
+
MR без них не открывается:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
GITLAB_TOKEN="$TOKEN" glab mr create \
|
|
76
|
+
--title '[<КЛЮЧ>-86] Письмо владельцу с незаполненным адресом попадает в логи' \
|
|
77
|
+
--assignee <бот> --reviewer <владелец> --label bug --label area:api \
|
|
78
|
+
--target-branch main --remove-source-branch \
|
|
79
|
+
--description 'Closes #86
|
|
80
|
+
|
|
81
|
+
…'
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
Ревьювер — всегда владелец: без запроса разбора MR не показывается ему в очереди. Исполнитель —
|
|
85
|
+
та же учётная запись, от которой идёт машинная работа. Метки читаются у задачи, а не выбираются
|
|
86
|
+
по памяти:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
glab issue view 86 --output json | jq -r '[.labels[]] | join(",")'
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Строка `Closes #<номер>` обязательна: без неё MR не прикрепляется к задаче, и сверка очереди
|
|
93
|
+
это находит. Она же означает, что задача закрывается целиком — половину задачи одним MR не
|
|
94
|
+
выкатывают: у задачи одна ветка, и работа, которая в неё не влезает, делится на задачи до того,
|
|
95
|
+
как ветка заводится.
|
|
96
|
+
|
|
97
|
+
У уже открытого MR то же ставится правкой:
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
glab mr update 205 --label bug --label area:api --assignee <бот> --reviewer <владелец>
|
|
101
|
+
glab mr update 205 --description "$(cat тело.md)"
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
Правка описания переписывает его целиком, поэтому строка `Closes #<номер>` пишется заново
|
|
105
|
+
вместе с остальным текстом. Описание перечитывается всякий раз, когда в ветку что-то влилось
|
|
106
|
+
после публикации: MR утверждает про дерево, а дерево с тех пор изменилось.
|
|
107
|
+
|
|
108
|
+
## Образец описания MR
|
|
109
|
+
|
|
110
|
+
Четыре раздела, и порядок между ними один: строка связи, что сделано, чем подтверждено,
|
|
111
|
+
оставшийся шаг. Раздел, которому нечего сказать, пишется словами — пустой заголовок и снятый
|
|
112
|
+
заголовок читаются одинаково, а значат разное.
|
|
113
|
+
|
|
114
|
+
```markdown
|
|
115
|
+
Closes #86
|
|
116
|
+
|
|
117
|
+
## Что сделано
|
|
118
|
+
|
|
119
|
+
- <правка, названная тем, что она меняет для читателя, а не тем, какие файлы задела>
|
|
120
|
+
|
|
121
|
+
## Чем подтверждено
|
|
122
|
+
|
|
123
|
+
- <проверка>: <её вывод одной строкой>
|
|
124
|
+
- Не гонялось: <что в набор не вошло и почему>
|
|
125
|
+
|
|
126
|
+
## Оставшийся шаг
|
|
127
|
+
|
|
128
|
+
После одобрения ветка получает ещё один коммит — разбор папки задачи, — и только потом
|
|
129
|
+
вливается. До этого коммита вливать рано: папка уедет в главную ветку неразобранной.
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Раздел «Оставшийся шаг» стоит последним и переписывается тем же вызовом, что и остальное
|
|
133
|
+
описание, — в тот ход, которым папка разбирается и снимается черновик:
|
|
134
|
+
|
|
135
|
+
```markdown
|
|
136
|
+
## Оставшийся шаг
|
|
137
|
+
|
|
138
|
+
Не осталось: папка задачи разобрана коммитом `<sha>`, черновик снят. Можно вливать.
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
Стоит он там потому, что решение о слиянии принимается на этой странице, а не в переписке:
|
|
142
|
+
сказанное владельцу вслух живёт до следующей реплики, а описание лежит у самой кнопки. Одно
|
|
143
|
+
другого не отменяет — порядок обоих сообщений владельцу описывает паттерн закрытия работы.
|
|
144
|
+
|
|
145
|
+
Проверить описание машиной нечем: ни одна сверка его не читает, а хостинг спрашивает только про
|
|
146
|
+
заголовок. Держится образец тем, кто пишет описание, — как и слова вслух.
|
|
147
|
+
|
|
148
|
+
## Состояние MR читается, а не додумывается
|
|
149
|
+
|
|
150
|
+
Команды правки отвечают нулевым кодом и тогда, когда ничего не сделали: токен без права на
|
|
151
|
+
проект молча не ставит ни метку, ни ревьювера. Поэтому после них MR перечитывают:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
glab mr view 205 --output json \
|
|
155
|
+
| jq '{author: .author.username, reviewers: [.reviewers[].username], labels: .labels}'
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
Владельцу называют то, что прочитали, а не то, что заказывали.
|
|
159
|
+
|
|
160
|
+
Учётная запись, из-под которой пришлось пушить, в этот вызов не переносится: пуш и авторство
|
|
161
|
+
MR выбираются отдельно, и токен для публикации — всегда токен машинной работы.
|
|
162
|
+
|
|
163
|
+
Перечитывают его и по времени, а не только после вызовов, которые молча ничего не сделали:
|
|
164
|
+
состояние MR читается перед тем, как что-либо о нём сказать. Между «прогон зелёный» и следующей
|
|
165
|
+
фразой владелец успевает влить MR, и всё сказанное о нём после этого — про вчерашний день. Так
|
|
166
|
+
владельцу и было предложено влить то, что он влил часом раньше.
|
|
167
|
+
|
|
168
|
+
Открытый MR означает, что задача ждёт разбора, — список переставляется тем же движением:
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
npm run task:move -- 86 in-review
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
## Что проверяется до публикации MR
|
|
175
|
+
|
|
176
|
+
Проверок на самом MR нет ровно до тех пор, пока конвейер не запущен, а запускается он пушем.
|
|
177
|
+
Линтеры, юниты и сценарии хуков снимает гейт пуша — ниже то, чего он не знает.
|
|
178
|
+
|
|
179
|
+
1. **Главная ветка влита в эту ветку** — `git fetch origin && git merge origin/main`.
|
|
180
|
+
Всё, что проверяется ниже, проверяется от этого основания: MR с разошедшейся ветки
|
|
181
|
+
показывает ревьюверу правку вперемешку с чужой. Порядок и разбор конфликта — паттерн
|
|
182
|
+
`git-workflow-merge`.
|
|
183
|
+
2. **В ветке только та правка, за которой её заводили** — `git diff main...HEAD --stat`. Чужой
|
|
184
|
+
домен в списке файлов означает, что правка расползлась, и её надо вернуть в свои границы.
|
|
185
|
+
3. **Ни мока, ни подменённого ответа, ни отладочной строки** — `git diff main...HEAD` читается
|
|
186
|
+
целиком, а не по именам файлов. На прод они уезжают молча и портят настоящие данные.
|
|
187
|
+
4. **Документ едет тем же коммитом.** Пару называет `docs-guard`, но спек домена и правку его
|
|
188
|
+
поведения он не знает — это остаётся за автором.
|
|
189
|
+
5. **Проверки текстов и раскладки зелёные** — те, что дерево завело в `tools/`. Какие именно
|
|
190
|
+
есть здесь — `implementation.md` правила.
|
|
191
|
+
6. **Все приложения дерева собираются** — `nx build` по каждому. Гейт пуша сборку не гоняет.
|
|
192
|
+
7. **Видимый текст заведён во всех локалях перевода** — тестом полноты словарей, если дерево
|
|
193
|
+
переводится.
|
|
194
|
+
8. **Правка вёрстки подтверждена замером**, а не взглядом, и снята при узком экране — паттерн
|
|
195
|
+
`browser-verification-measure`.
|
|
196
|
+
9. **Правка разметки публичного сайта проверена на прод-сборке по всем локалям перевода** —
|
|
197
|
+
паттерн `seo-verify`.
|
|
198
|
+
10. **Описание MR собрано по образцу** — начинается строкой `Closes #<номер>`, несёт разделы
|
|
199
|
+
«Что сделано», «Чем подтверждено» и «Оставшийся шаг», а метки, ревьювер и исполнитель
|
|
200
|
+
стоят. Раздел оставшегося шага к этому моменту говорит, что шагов не осталось: черновик
|
|
201
|
+
снимается после разбора папки, а не до него.
|
|
202
|
+
11. **Заголовок MR несёт номер задачи и называет её сделанной:** `[<КЛЮЧ>-<номер>] <Что
|
|
203
|
+
сделано>`, тем же номером, что стоит у задачи и в имени ветки.
|
|
204
|
+
12. **Очередь работ сходится** — `npm run check:board`.
|
|
205
|
+
13. **Состояние MR прочитано, а не выведено из кодов возврата.**
|
|
206
|
+
14. **Набор взят из файла конвейера, а не собран по памяти.** Гейт пуша заведомо уже: он стоит
|
|
207
|
+
между командой и пушем, и всё, что дольше секунд, из него вынесено. Что гоняет конвейер,
|
|
208
|
+
написано в его файле — этот список и повторяется локально; зелёный гейт полнотой набора не
|
|
209
|
+
является.
|
|
210
|
+
15. **Набор пересмотрен после вливания главной ветки.** Он выбирается по тому, что ветка везёт
|
|
211
|
+
теперь, а не по тому, что правил автор. Ветка, не тронувшая ни строки показа, прогоняет
|
|
212
|
+
снимки витрин: с момента вливания их гоняет конвейер на её коде, и красное придёт на её
|
|
213
|
+
PR.
|
|
214
|
+
|
|
215
|
+
Сразу после публикации задача переставляется в разбор, и сверка очереди прогоняется ещё раз: до
|
|
216
|
+
открытия MR список она не судит, а после открытия расхождение видит.
|
|
217
|
+
|
|
218
|
+
Сделанное рассуждением и сделанное замером в теле MR разводятся прямо: непроверенное,
|
|
219
|
+
названное проверенным, ревьювер принимает за проверенное.
|
|
220
|
+
|
|
221
|
+
**Раздел «Чем подтверждено» называет и то, что не гонялось.** Список одного прогнанного
|
|
222
|
+
неотличим от полного набора, и ревьювер по нему решает, что можно не перепроверять. Цена ошибки
|
|
223
|
+
здесь не красный конвейер, а доверие к разделу: однажды прочитанный как полнота, дальше он
|
|
224
|
+
перепроверяется весь.
|
|
225
|
+
|
|
226
|
+
## Частые промахи
|
|
227
|
+
|
|
228
|
+
Промахи про заведение задачи, ветку и коммит — паттерн
|
|
229
|
+
`git-workflow-commit`.
|
|
230
|
+
|
|
231
|
+
- MR открыт без ревьювера: он не попадает во входящие владельца, и очередь стоит, выглядя
|
|
232
|
+
работающей.
|
|
233
|
+
- Метки поставлены по названию MR, а не прочитаны у задачи: область теряется, и по доске не
|
|
234
|
+
видно, что правка задела ещё и соседний домен.
|
|
235
|
+
- Вторая строка `Closes` в одном MR: две задачи в одной ветке откатываются только вместе. Либо
|
|
236
|
+
это одна задача — и вторая поглощается, — либо две ветки.
|
|
237
|
+
- Половина задачи, уехавшая своим MR: описание такого MR начинается со слов «Часть #<номер>»
|
|
238
|
+
вместо `Closes`, задача остаётся открытой, и после отката видно её целой.
|
|
239
|
+
- `--remove-source-branch` забыт: ветки задач копятся в репозитории, и по списку веток больше
|
|
240
|
+
не видно, какая работа идёт сейчас.
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: git-workflow-restart
|
|
3
3
|
kind: pattern
|
|
4
|
-
rule:
|
|
5
|
-
description: Паттерн правила
|
|
4
|
+
rule: deploy-flow
|
|
5
|
+
description: Паттерн правила deploy-flow. Брать при ручном перезапуске прода — после правки .env.prod, при разборе выкатки, при подъёме контейнера на сервере. Готовые команды с IMAGE_TAG по sha, способ узнать выкаченный sha и чем сверять результат. Не брать для коммита и миграций — это паттерны git-workflow-commit и git-workflow-migration.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Ручной перезапуск прода
|
|
9
9
|
|
|
10
|
-
Паттерн правила `
|
|
10
|
+
Паттерн правила `deploy-flow`. Что при этом должно быть верно — закон
|
|
11
11
|
`docs/constitution/delivery.md`.
|
|
12
12
|
|
|
13
13
|
## Когда брать
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: git-workflow-secrets
|
|
3
3
|
kind: pattern
|
|
4
|
-
rule:
|
|
5
|
-
description: Паттерн правила
|
|
4
|
+
rule: deploy-flow
|
|
5
|
+
description: Паттерн правила deploy-flow. Брать при работе с ключами внешних служб — где они лежат, чем ключ, заводимый владельцем, отличается от ключа окружения, что означает каждое состояние строки интеграции и почему зелёная проба не обещает работающей возможности. Не брать для перезапуска прода и выбора образа — это паттерн git-workflow-restart.
|
|
6
6
|
---
|
|
7
7
|
|
|
8
8
|
# Ключи внешних служб
|
|
9
9
|
|
|
10
|
-
Паттерн правила `
|
|
10
|
+
Паттерн правила `deploy-flow`. Что при этом должно быть верно — закон
|
|
11
11
|
`docs/constitution/delivery.md`.
|
|
12
12
|
|
|
13
13
|
## Когда брать
|