Skip to content

Commit d8a1053

Browse files
committed
DEVELOPER.md: Update instructions for upgrading to new TZDB version
1 parent 686d771 commit d8a1053

File tree

1 file changed

+47
-16
lines changed

1 file changed

+47
-16
lines changed

DEVELOPER.md

Lines changed: 47 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -565,31 +565,52 @@ available.
565565
* `$ make clean`
566566
* `$ make`
567567
* `$ ./BasicHinnantDateTest.out | grep failed`
568-
* There should be no failures: `TestRunner summary: 268 passed, 0
569-
failed, 0 skipped, 0 timed out, out of 268 test(s).`
568+
* There should be no failures.
570569
* ExtendedHinnantDateTest
571570
* `$ cd .../AceTimeValidation/ExtendedHinnantDateTest`
572571
* Update the `TZ_VERSION` variable in the `Makefile` with the commit tag
573572
of the new TZDB version. (e.g. `TZ_VERSION = 2020c`).
574573
* `$ make clean`
575574
* `$ make`
576575
* `$ ./ExtendedHinnantDateTest.out | grep failed`
577-
* There should be no failures: `TestRunner summary: 387 passed, 0
578-
failed, 0 skipped, 0 timed out, out of 387 test(s).`
579-
* Update the various zone info files:
580-
* `src/ace_time/zonedb`
576+
* There should be no failures.
577+
* Verify that the `AceTime` library and the `AceTimePython` library agree with
578+
each other using the same TZDB version. This requires going into the
579+
[AceTimeValidation](https://github.com/bxparks/AceTimeValidation) project.
580+
* BasicAcetzTest
581+
* `$ cd .../AceTimeValidation/BasicAcetzTest`
582+
* Update the `TZ_VERSION` variable in the `Makefile` with the commit tag
583+
of the new TZDB version. (e.g. `TZ_VERSION = 2020c`).
584+
* `$ make clean`
585+
* `$ make`
586+
* `$ ./BasicAcetzTest.out | grep failed`
587+
* There should be no failures.
588+
* ExtendedAcetzTest
589+
* `$ cd .../AceTimeValidation/ExtendedAcetzTest`
590+
* Update the `TZ_VERSION` variable in the `Makefile` with the commit tag
591+
of the new TZDB version. (e.g. `TZ_VERSION = 2020c`).
592+
* `$ make clean`
593+
* `$ make`
594+
* `$ ./ExtendedAcetzTest.out | grep failed`
595+
* There should be no failures.
596+
* Update the various zoneinfo files for AceTime:
597+
* `zonedb`
581598
* `$ cd src/ace_time/zonedb`
582599
* Edit the `Makefile` and update the `TZ_VERSION`.
583600
* `$ make`
584-
* `src/ace_time/zonedbx`
601+
* `zonedbx`
585602
* `$ cd src/ace_time/zonedbx`
586603
* Edit the `Makefile` and update the `TZ_VERSION`.
587604
* `$ make`
588-
* `AceTimeTools/zonedbpy`
589-
* `$ cd AceTimeTools/zonedbpy`
605+
* Update the zoneinfo files for AceTimePython:
606+
* ``zonedbpy`
607+
* `$ cd AceTimePython/src/acetime/zonedbpy`
590608
* Edit the `Makefile` and update the `TZ_VERSION`.
591609
* `$ make`
592-
* Update the CHANGELOG.md.
610+
* Update CHANGELOGs
611+
* AceTime/CHANGELOG.md
612+
* AceTimePython/CHANGELOG.md
613+
* AceTimeValidation/CHANGELOG.md
593614
* Commit the changes to git
594615
* `$ git add ...`
595616
* `$ git commit -m "..."`
@@ -628,7 +649,7 @@ tests will fail until the underlying timezone database of the OS is updated.
628649
* Go to https://github.com/bxparks/AceTime.
629650
* Create a Pull Request from `develop` to `master`.
630651
* Approve and merge the PR.
631-
* Create a new Release.
652+
* Create a new Release of AceTime.
632653
* Go to https://github.com/bxparks/AceTime
633654
* Click on "Releases"
634655
* Click on "Draft a new release"
@@ -637,9 +658,19 @@ tests will fail until the underlying timezone database of the OS is updated.
637658
* Enter the release notes. I normally just copy and paste the latest changes
638659
from `CHANGELOG.md`.
639660
* Click Publish release.
661+
* Create a new Release of AceTimePython.
662+
* Go to https://github.com/bxparks/AceTimePython
663+
* Click on "Releases"
664+
* Click on "Draft a new release"
665+
* Enter a tag version (e.g. `v1.2`), targeting the `master` branch.
666+
* Enter the release title.
667+
* Enter the release notes. I normally just copy and paste the latest changes
668+
from `CHANGELOG.md`.
669+
* Click Publish release.
640670
* Add corresponding tags on AceTimeTools and AceTimeValidation for reference.
641-
* Go to https://github.com/bxparks/AceTimeTools
642-
* `$ git tag -a 'atX.Y.Z' -m 'AceTime vX.Y.Z'`
643-
* `$ git push --tags`
644-
* Go to https://github.com/bxparks/AceTimeValidation
645-
* (Same as above)
671+
* AceTimePython
672+
* `$ git tag -a 'atX.Y.Z' -m 'AceTime vX.Y.Z'`
673+
* `$ git push --tags`
674+
* AceTimeValidation
675+
* `$ git tag -a 'atX.Y.Z' -m 'AceTime vX.Y.Z'`
676+
* `$ git push --tags`

0 commit comments

Comments
 (0)