|
1 | | -# IANA Time Zone Database to iCalendar Translation Database |
2 | | - |
3 | | -This repo tracks releases of the [IANA Time Zone Database](https://www.iana.org/time-zones) together with the corresponding translations to the iCalendar format (as defined in RFC 5545). |
4 | | - |
5 | | -The translation is performed using [libical's VZIC utility](https://github.com/libical/vzic). |
6 | | - |
7 | | -## Updating to a new release of the Time Zone Database |
8 | | - |
9 | | -The intended usage is as follows: |
10 | | -* Upon a new release of the IANA Time Zone Database update `settings.config`. Update `VZIC_RELEASE_NAME` to match the name of the new release (e.g. `2022a`). |
11 | | -* Commit and push the change to GitHub. |
12 | | - |
13 | | -This will trigger a GitHub Workflow that does the following |
14 | | -* Download the specified version of the IANA Time Zone DB. |
15 | | -* Checkout, build and run vzic |
16 | | -* Merge the newly generated zoneinfo with the previous version, in order to keep TZIDs of unchanged time zones. |
17 | | -* Commit and push the updated tzdata and zoneinfo back to the repo on GitHub. |
18 | | - |
19 | | -## Creating a release |
20 | | - |
21 | | -To create a new release: |
22 | | - |
23 | | -* Bump and push `VZIC_RELEASE_NAME` as outlined above. |
24 | | -* Create a tag named `release_$VZIC_RELEASE_NAME` on the commit created by GitHub Actions. |
25 | | -* Create a GitHub release with the same name on the new tag. |
26 | | - * Add the build artifacts from the automatic build (should be `tzdata$VZIC_RELEASE_NAME.tar.gz` and `zoneinfo-$VZIC_RELEASE_NAME.tar.gz`). |
| 1 | +# IANA Time Zone Database to iCalendar Translation Database |
| 2 | + |
| 3 | +This repo tracks releases of the [IANA Time Zone Database](https://www.iana.org/time-zones) together with the corresponding translations to the iCalendar format (as defined in RFC 5545). |
| 4 | + |
| 5 | +The translation is performed using [libical's VZIC utility](https://github.com/libical/vzic). |
| 6 | + |
| 7 | +## Updating to a new release of the Time Zone Database |
| 8 | + |
| 9 | +The intended usage is as follows: |
| 10 | +* Upon a new release of the IANA Time Zone Database update `settings.config`. Update `VZIC_RELEASE_NAME` to match the name of the new release (e.g. `2022a`). |
| 11 | +* Commit and push the change to GitHub. |
| 12 | + |
| 13 | +This will trigger a GitHub Workflow that does the following |
| 14 | +* Download the specified version of the IANA Time Zone DB. |
| 15 | +* Checkout, build and run vzic |
| 16 | +* Merge the newly generated zoneinfo with the previous version, in order to keep TZIDs of unchanged time zones. |
| 17 | +* Commit and push the updated tzdata and zoneinfo back to the repo on GitHub. |
| 18 | + |
| 19 | +## Creating a release |
| 20 | + |
| 21 | +To create a new release: |
| 22 | + |
| 23 | +* Bump and push `VZIC_RELEASE_NAME` as outlined above. |
| 24 | +* Create a tag named `release_$VZIC_RELEASE_NAME` on the commit created by GitHub Actions. |
| 25 | +* Create a GitHub release with the same name on the new tag. |
| 26 | + * Add the build artifacts from the automatic build (should be `tzdata$VZIC_RELEASE_NAME.tar.gz` and `zoneinfo-$VZIC_RELEASE_NAME.tar.gz`). |
0 commit comments