Skip to content

Commit 68fca55

Browse files
authored
Update UPDATING.md
1 parent a27aff2 commit 68fca55

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

UPDATING.md

Lines changed: 13 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
2323
### Building
2424

2525
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.
2727
3. Run the script `cldr-generate-json.sh`
2828
4. Data will be updated in the recreated `cldr-json` subdirectory.
2929

@@ -35,15 +35,15 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
3535

3636
### Updating the Repository
3737

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.
3939
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.
4040
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.
4242

4343
### Publishing
4444

4545
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.
4747
3. Update the npm packages. Each sub-subdirectory of `cldr-json/cldr-json` is a separate npm package. The following script will preview
4848
(dry run) publishing to npm under the `beta` tag. Check the version carefully!
4949

@@ -55,17 +55,21 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
5555
5656
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."
5757
58+
### Final
59+
60+
- When the release is final, get the PR approved and merge it into main, deleting the `v44` branch.
61+
5862
### Customization
5963
6064
See `cldr-config.sh` for customization options.
6165
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`
6468
6569
Example, if you have a different directory layout:
6670
6771
```shell
68-
# VERSION defaults to calculating the version
72+
# VERSION must be set
6973
VERSION=43.0.0-ALPHA2
7074
7175
# CLDR_DIR defaults to ../cldr
@@ -75,15 +79,6 @@ CLDR_DIR=../cldr-maint-43
7579
INDATA=../cldr-staging-other/production
7680
```
7781
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).
82-
83-
SPDX-License-Identifier: Unicode-DFS-2016
84-
85-
## Copyright
82+
## License & Copyright
8683
87-
Copyright © 1991-2023 Unicode, Inc.
88-
All rights reserved.
89-
[Terms of use](http://www.unicode.org/copyright.html)
84+
See [README.md](./README.md)

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy