You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: UPDATING.md
+13-18Lines changed: 13 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
23
23
### Building
24
24
25
25
1.`cd` to `cldr-json`
26
-
2.*Delete* the `cldr-json/cldr-json` subdirectory (the subdirectory of `cldr-json`). This way, git will tell you what has changed, and you can see if any files failed to regenerate.
26
+
2.*Delete* the `cldr-json/cldr-json` subdirectory (the subdirectory of `cldr-json`). This way, git will tell you what has changed, and you can see if any files failed to regenerate or were newly added.
27
27
3. Run the script `cldr-generate-json.sh`
28
28
4. Data will be updated in the recreated `cldr-json` subdirectory.
29
29
@@ -35,15 +35,15 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
35
35
36
36
### Updating the Repository
37
37
38
-
1. Run `git checkout -b ...` to create a new branch.
38
+
1. Run `git checkout -b ...` to create a new branch. Typical practice is to create a new branch for a major version, such as `v44`, and only merge it back to `main` upon release.
39
39
2. Run `git status` to check whether there are any newly added files/directories such as for new locales, or removed files/directories. If you see any files or directories named `other…`, stop, because there's a generation problem.
40
40
3. Run `git add cldr-json` to add the entire nested `cldr-json` subdirectory.
41
-
4.Make a pull request (`git commit ...`, `git push`, ...), get it approved, and merge it.
41
+
4.Open a draft pull request for the `v44` branch to be able to track updates to the data in progress.
42
42
43
43
### Publishing
44
44
45
45
1. Run the script `cldr-generate-zip.sh` to generate zipfiles under `dist/`; their names will include `VERSION`, for example: `cldr-44.0.0-ALPHA2-json-full.zip`.
46
-
2. Create a release tag matching VERSION in this repository. Create a GitHub release, use other [releases](https://github.com/unicode-org/cldr-json/releases) as a guide.
46
+
2. Create a release tag matching VERSION in this repository. Create a GitHub release, use other [releases](https://github.com/unicode-org/cldr-json/releases) as a guide. Make sure the release is marked as "pre-release" if it isn't final.
47
47
3. Update the npm packages. Each sub-subdirectory of `cldr-json/cldr-json` is a separate npm package. The following script will preview
48
48
(dry run) publishing to npm under the `beta` tag. Check the version carefully!
49
49
@@ -55,17 +55,21 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
55
55
56
56
4. Upload the zipfiles from `dist/` to the release page, by dragging and dropping them where it says "Attach binaries by dropping them here or selecting them."
57
57
58
+
### Final
59
+
60
+
- When the release is final, get the PR approved and merge it into main, deleting the `v44` branch.
61
+
58
62
### Customization
59
63
60
64
See `cldr-config.sh`for customization options.
61
65
62
-
You can create an executable script named `local-config.sh` with
63
-
values to update, for example`VERSION`, `TYPES`, `MATCH` or `DRAFTSTATUS`
66
+
You must create an executable script named `local-config.sh` with
67
+
values to update, at minimum`VERSION`, but also`TYPES`, `MATCH` or `DRAFTSTATUS`
64
68
65
69
Example, if you have a different directory layout:
66
70
67
71
```shell
68
-
# VERSION defaults to calculating the version
72
+
# VERSION must be set
69
73
VERSION=43.0.0-ALPHA2
70
74
71
75
# CLDR_DIR defaults to ../cldr
@@ -75,15 +79,6 @@ CLDR_DIR=../cldr-maint-43
75
79
INDATA=../cldr-staging-other/production
76
80
```
77
81
78
-
## Licenses
79
-
80
-
- Usage of CLDR data and software is governed by the [Unicode Terms of Use](http://www.unicode.org/copyright.html)
81
-
a copy of which is included as [unicode-license.txt](./unicode-license.txt).
0 commit comments