Skip to content

Commit

Permalink
Merge pull request #71 from unicode-org/srl295/update-updating-again
Browse files Browse the repository at this point in the history
Update UPDATING.md
  • Loading branch information
srl295 authored Jan 31, 2025
2 parents ce4028a + 3fb7ad0 commit 61d9cba
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions UPDATING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,10 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
### Building

1. `cd` to `cldr-json`
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.
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.
3. Run the script `cldr-generate-json.sh`
4. Data will be updated in the recreated `cldr-json` subdirectory.
5. Also note that the `PACKAGES.md` file at the TOP level may be updateed, make sure to commit this as well.

#### Troubleshooting

Expand All @@ -35,17 +36,17 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)

### Updating the Repository

1. Run `git checkout -b ...` to create a new branch.
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.
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.
3. Run `git add cldr-json` to add the entire nested `cldr-json` subdirectory.
4. Make a pull request (`git commit ...`, `git push`, ...), get it approved, and merge it.
4. Open a draft pull request for the `v44` branch to be able to track updates to the data in progress.

### Publishing

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`.
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.
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.
3. Update the npm packages. Each sub-subdirectory of `cldr-json/cldr-json` is a separate npm package. The following script will preview
(dry run) publishing to npm under the `beta` tag. Check the version carefully!
(dry run) publishing to npm under the `beta` tag. Check the version carefully—not to put too fine a point on it, but once published, a particular version number cannot be republished. (Tags may be moved as needed.)

```shell
(cd cldr-json; npm login; for repo in $(ls); do (cd $repo; npm publish --tag beta --dry-run); done)
Expand All @@ -55,17 +56,21 @@ Make sure your `cldr-json` directory is otherwise clean (`git status`)
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."
### Final
- When the release is final, get the PR approved and merge it into main, deleting the `v44` branch.
### Customization
See `cldr-config.sh` for customization options.
You can create an executable script named `local-config.sh` with
values to update, for example `VERSION`, `TYPES`, `MATCH` or `DRAFTSTATUS`
You must create an executable script named `local-config.sh` with
values to update, at minimum `VERSION`, but also `TYPES`, `MATCH` or `DRAFTSTATUS`
Example, if you have a different directory layout:
```shell
# VERSION defaults to calculating the version
# VERSION must be set
VERSION=43.0.0-ALPHA2
# CLDR_DIR defaults to ../cldr
Expand All @@ -75,7 +80,7 @@ CLDR_DIR=../cldr-maint-43
INDATA=../cldr-staging-other/production
```
## Licenses
## License & Copyright
- Usage of CLDR data and software is governed by the [Unicode Terms of Use](http://www.unicode.org/copyright.html)
a copy of which is included as [unicode-license.txt](./unicode-license.txt).
Expand All @@ -84,6 +89,6 @@ SPDX-License-Identifier: Unicode-DFS-2016
## Copyright
Copyright © 1991-2024 Unicode, Inc.
Copyright © 1991-2025 Unicode, Inc.
All rights reserved.
[Terms of use](http://www.unicode.org/copyright.html)

0 comments on commit 61d9cba

Please sign in to comment.