Skip to content

Commit 1c3c031

Browse files
authored
Update the pipeline documentation to cover changes in process (#1042)
1 parent bca50a4 commit 1c3c031

File tree

1 file changed

+53
-11
lines changed

1 file changed

+53
-11
lines changed

docs/pipeline.md

Lines changed: 53 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,23 +48,39 @@ Indic scripts only:
4848
- [ ] IndicSyllabicCategory — Prepend lines from proposal
4949
- [ ] Commit
5050

51-
---
52-
- [ ] PropsList.txt — Add Other_Alphabetic, Other_Lowercase, Diacritic, and Extender to satisfy invariants, or to taste
53-
- [ ] Commit
54-
5551
---
5652
- [ ] UCD — [Regenerate](#regenerate-ucd)
5753
- [ ] Enums — [Regenerate](#generateenums)
5854

55+
---
56+
- [ ] In unicodetools/src/main/resources/org/unicode/text/UCD/AdditionComparisons,
57+
copy template.txt to [RMG issue number].txt.
58+
- [ ] Comparison tests — Write
59+
- Examples:
60+
- [straightforward characters](https://github.com/unicode-org/unicodetools/blob/08748760e371d9dbdc6a0fc883c68dff944648e2/unicodetools/src/main/resources/org/unicode/text/UCD/AdditionComparisons/182.txt#L11-L18),
61+
- [various Latin (lowercase-only, case pairs, modifiers)](https://github.com/unicode-org/unicodetools/blob/4f8a581c77fdda2d572a16b28e74d865a689108e/unicodetools/src/main/resources/org/unicode/text/UCD/AdditionComparisons/155.txt#L11-L72),
62+
- [numeric characters](https://github.com/unicode-org/unicodetools/blob/84f6110737037e74c22a66d812b398f4e3adb5b7/unicodetools/src/main/resources/org/unicode/text/UCD/AdditionComparisons/175.txt#L11-L34),
63+
- [characters decomposing to sequences](https://github.com/unicode-org/unicodetools/blob/5f6bc190766ed9104cebc828f1e193517f4d74ec/unicodetools/src/main/resources/org/unicode/text/UCD/AdditionComparisons/141.txt#L13-L20).
64+
- Until tests pass:
65+
- [ ] Comparison tests — [Run](#run-comparison-tests)
66+
- [ ] Correct properties (often in PropList.txt, but also VerticalOrientation.txt, East_Asian_Width.txt, etc.).
67+
- [ ] Commit
68+
- [ ] UCD — [Regenerate](#regenerate-ucd)
69+
5970
---
6071
PR preparation:
61-
- [ ] If from SAH — Link SAH issue
62-
- [ ] If from ESC or CJK — Mention ESC or CJK in the PR description
63-
- [ ] When for a UTC decision — Cite in the format UTC-\d\d\d-[MC]\d+ or with a link.
64-
- [ ] Link RMG issue
65-
- [ ] Whenever there is a Proposal document — Cite L2 number in the format L2/yy-nnn
72+
- [ ] UTC decision — Cite if available
73+
- Copy from the minutes (this includes a link), or, if unavailable, use the form UTC-\d\d\d-[MC]\d+.
74+
- If there is no UTC decision but an L2 document is available, cite as L2/\d\d-\d+.
75+
- [ ] Working group — Mention:
76+
- Proposals from SAH — Link SAH issue
77+
- Proposals from ESC or CJK — Mention ESC or CJK in the PR description
78+
- [ ] RMG issue — Link
6679
- [ ] data-for-new — Set label
67-
- [ ] pipeline-* — Set label to **pipeline-recommended-to-UTC** if the characters are not yet in the pipeline, and **pipeline-provisionally-assigned**, or **pipeline-`<version>`** depending on their status in [the Pipeline](https://unicode.org/alloc/Pipeline.html#future).
80+
- [ ] pipeline-* — Set label:
81+
- **pipeline-recommended-to-UTC** if the characters are not yet in the pipeline,
82+
- **pipeline-provisionally-assigned**, or
83+
- **pipeline-`<version>`** depending on their status in [the Pipeline](https://unicode.org/alloc/Pipeline.html#future).
6884
- [ ] PR button — Set to DRAFT pull request
6985
- unless approved for the upcoming version
7086
- [ ] PR button — Press
@@ -75,7 +91,24 @@ PR preparation:
7591
in the UCD invariants.
7692
UCA and security data issues are addressed later in the process,
7793
before the start of β review.
78-
94+
- [ ] PAG review summary for the report — Write
95+
- For proposals from SAH, use the following template in the SAH issue:
96+
```markdown
97+
# PAG Review
98+
99+
[Name] drafted the UCD change in https://github.com/unicode-org/unicodetools/pull/[number].
100+
101+
## PAG report
102+
103+
[Summarize the propertywise tests, omitting the uninteresting, _e.g._, differences in Block or
104+
Unicode_1_Name, and calling out the nontrivial (in particular, any issues that were caught by
105+
the tests).]
106+
```
107+
- For proposals from CJK, file a PAG issue of type `Document`, citing the proposal.
108+
Put the review in the `Background information / discussion` section, and link the pull request
109+
in the `Internal` section. See, _e.g._, https://github.com/unicode-org/properties/issues/366.
110+
- [ ] PAG dashboard status of SAH or PAG issue — Set to `Review`
111+
- [ ] Pipeline dashboard PAG status of RMG issue — Set to `data review`
79112
## Scripts
80113

81114
There are a variety of setups for unicodetools, depending on OS, in-source vs. out-of-source, git practices, etc.
@@ -190,3 +223,12 @@ mvn spotless:apply
190223
git add *.java
191224
git commit -m GenerateEnums
192225
```
226+
227+
228+
### Run comparison tests
229+
230+
eggrobin (Windows, in-source).
231+
```powershell
232+
mvn test -am -pl unicodetools "-DCLDR_DIR=$(gl|split-path -parent)\cldr\" "-DUNICODETOOLS_GEN_DIR=$(gl|split-path -parent)\unicodetools\Generated\" "-DUNICODETOOLS_REPO_DIR=$(gl|split-path -parent)\unicodetools\" "-DUVERSION=17.0.0" "-Dtest=TestTestUnicodeInvariants#testAdditionComparisons" -DfailIfNoTests=false -DtrimStackTrace=false
233+
```
234+
Results are in Generated\UnicodeTestResults-addition-comparisons-[RMG issue number].html.

0 commit comments

Comments
 (0)