ICU-22993 Prototype of Modernize Calendar API

.github/pull_request_template.md

@@ -8,8 +8,8 @@ Thank you for your pull request!
 * Associating PRs with Jira issues
   - We require each pull request to be associated with a [Jira issue](https://icu.unicode.org/bugs).
   - Reuse existing issues for minor changes:
-    * ICU 77 docs minor fixes: ICU-22921 — User Guide & API docs typos etc., and version updates (e.g., dependabot for User Guide)
-    * ICU 77 code warnings/version updates: ICU-22920 — Fix compiler warnings. Update versions of code-related dependencies (e.g., dependabot).
+    * ICU 78 docs minor fixes: ICU-23055 — User Guide & API docs typos etc., and version updates (e.g., dependabot for User Guide)
+    * ICU 78 code warnings/version updates: ICU-23054 — Fix compiler warnings. Update versions of code-related dependencies (e.g., dependabot).
 * Contributors license agreement (CLA):
   - You will be automatically asked to sign the CLA before the PR is accepted.
   - To sign the CLA: https://cla-assistant.io/unicode-org/icu

.github/workflows/brs-commit-checker.yml

@@ -0,0 +1,64 @@
+name: BRS Commit Checker Report
+on:
+      workflow_dispatch:
+        inputs:
+            fix_version:
+                type: string
+                required: true
+                description: The ICU Jira "Fix Version" semver
+            from_git_ref:
+                type: string
+                required: true
+                description: The git ref start of comparison range. Prefix branches with `origin/`.
+            end_git_ref:
+                type: string
+                required: true
+                description: The git ref end of comparison range. Must be descendant of `from_git_ref`. Prefix branches with `origin/`.
+            # Jira user name & API token is used for processing sensitive tickets comes from Github Secrets
+            # stored in the repository
+
+jobs:
+    commit-report:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                fetch-tags: true
+                fetch-depth: 0
+            # workaround for bug in checkout action. this step should be redundant.
+            # https://github.com/actions/checkout/issues/1471
+            # https://github.com/actions/checkout/issues/1781
+            # https://github.com/actions/checkout/issues/701#issuecomment-1133937950
+            - name: Fetch all tags
+              run: |
+                git fetch --tags origin
+            - name: Fetch all branches
+              run: |
+                git fetch origin
+            - name: Setup Python
+              uses: actions/setup-python@v5
+              with:
+                python-version: '3.12.8'
+                cache: 'pipenv'
+                cache-dependency-path: |
+                    tools/commit-checker/Pipfile
+                    tools/commit-checker/Pipfile.lock
+            - name: Install pipenv
+              run: |
+                sudo pip3 install pipenv
+            - name: Generate report
+              env:
+                JIRA_USERNAME: ${{ secrets.COMMIT_CHECKER_JIRA_EMAIL }}
+                JIRA_PASSWORD: ${{ secrets.COMMIT_CHECKER_JIRA_TOKEN }}
+              run: |
+                pushd ./tools/commit-checker
+                pipenv install
+                pipenv run python3 check.py \
+                    --jira-query "project=ICU AND fixVersion=${{ inputs.fix_version }}" \
+                    --rev-range "${{ inputs.from_git_ref }}..${{ inputs.end_git_ref }}" > REPORT.md
+                popd
+            # https://github.blog/news-insights/product-news/supercharging-github-actions-with-job-summaries/
+            - name: Reproduce report as workflow job summary
+              run: |
+                cat ./tools/commit-checker/REPORT.md >> $GITHUB_STEP_SUMMARY
+                echo "View the Summary page of this GHA Workflow instance to view the rendered Markdown of this report."

.github/workflows/cache_retain.yml

@@ -52,7 +52,7 @@ jobs:
           distribution: 'temurin'
           java-version: '11'
       - name: Restore read-only cache of local Maven repository
-        uses: actions/cache/restore@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache/restore@v4.2.0
         id: cache
         with:
           path: ~/.m2/repository

.github/workflows/cifuzz.yml

@@ -55,7 +55,7 @@ jobs:
         path: ./out/artifacts   
     - name: Upload Sarif
       if: always() && steps.build.outcome == 'success'
-      uses: github/codeql-action/upload-sarif@v3.26.6
+      uses: github/codeql-action/upload-sarif@v3.28.10
       with:
         # Path to SARIF file relative to the root of the repository
         sarif_file: cifuzz-sarif/results.sarif

.github/workflows/icu4c.yml

@@ -53,7 +53,7 @@ jobs:
           ./runConfigureICU Linux --disable-renaming;
            # Fail if 'warning:' appears in doxygen's output, but ignore warnings from file Doxyfile.
            # Regex note: (?! ... ) is a negative lookahead. Succeed if the pattern is not present.
-          set +o pipefail && make doc 2>&1 | tee doxygen.log && ( ! grep -P 'warning:(?! .* file .?Doxyfile)' doxygen.log )
+          set +o pipefail && make doc-searchengine 2>&1 | tee doxygen.log && ( ! grep -P 'warning:(?! .* file .?Doxyfile)' doxygen.log )
 
   # gcc debug build.
   # Includes dependency checker.
@@ -740,13 +740,13 @@ jobs:
     runs-on: ubuntu-22.04  # Updated in BRS
     steps:
     - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-    - uses: bazelbuild/setup-bazelisk@b39c379c82683a5f25d34f0d062761f62693e0b2 # v3.0.0
+    - uses: bazel-contrib/setup-[email protected].0
     - name: Get CI Linux runner VM version
       id: linux-version
       run: |
         echo "LINUX_VERSION=$(grep -F VERSION_ID /etc/os-release | cut -d'"' -f2)" >> $GITHUB_OUTPUT
     - name: Mount bazel cache
-      uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+      uses: actions/cache@v4.2.0
       with:
         path: "~/.cache/bazel"
         key: bazel-${{ runner.os }}-${{ steps.linux-version.outputs.LINUX_VERSION }}

.github/workflows/icu_merge_ci.yml

@@ -45,7 +45,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Cache local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -71,7 +71,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Lookup read-only cache of local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -144,7 +144,7 @@ jobs:
       - name: Create directory for lib files
         run: mkdir icu4c/source/perflib
       - name: Get ICU libs
-        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        uses: actions/download-artifact@cc203385981b70ca67e1cc392babf9cc229d5806 # v4.1.9
         with:
           name: icu-perf-libs
           path: icu4c/source/lib
@@ -218,7 +218,7 @@ jobs:
       - name: Create directory for lib files
         run: mkdir icu4c/source/perflib
       - name: Get ICU libs
-        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        uses: actions/download-artifact@cc203385981b70ca67e1cc392babf9cc229d5806 # v4.1.9
         with:
           name: icu-perf-libs
           path: icu4c/source/lib
@@ -283,7 +283,7 @@ jobs:
       - name: Create directory for lib files
         run: mkdir icu4c/source/perflib
       - name: Get ICU libs
-        uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+        uses: actions/download-artifact@cc203385981b70ca67e1cc392babf9cc229d5806 # v4.1.9
         with:
           name: icu-perf-libs
           path: icu4c/source/lib
@@ -335,7 +335,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Lookup read-only cache of local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -349,11 +349,6 @@ jobs:
 
       - name: Build and run unicodesetperf test
         run: |
-          # This file needs to be restored  otherwise GHA cannot
-          # check-out the perfdata branch. Setting up this task with GH lfs
-          # modifies the file but the details of why and how are unknown.
-          git restore --staged tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
-          git restore tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
           cd icu4j;
           mvn ${SHARED_MVN_ARGS} verify -DskipITs -DskipTests;
           git status
@@ -397,7 +392,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Lookup read-only cache of local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -411,11 +406,6 @@ jobs:
 
       - name: Build and run ucharacterperf test
         run: |
-          # This file needs to be restored  otherwise GHA cannot
-          # check-out the perfdata branch. Setting up this task with GH lfs
-          # modifies the file but the details of why and how are unknown.
-          git restore --staged tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
-          git restore tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
           cd icu4j;
           mvn ${SHARED_MVN_ARGS} verify -DskipITs -DskipTests;
           cd perf-tests;
@@ -461,7 +451,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Lookup read-only cache of local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -475,11 +465,6 @@ jobs:
 
       - name: Build and run decimalformatperf
         run: |
-          # This file needs to be restored  otherwise GHA cannot
-          # check-out the perfdata branch. Setting up this task with GH lfs
-          # modifies the file but the details of why and how are unknown.
-          git restore --staged tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
-          git restore tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
           cd icu4j;
           mvn ${SHARED_MVN_ARGS} verify -DskipITs -DskipTests;
           cd perf-tests;
@@ -530,7 +515,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Lookup read-only cache of local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -546,11 +531,6 @@ jobs:
         env:
           DATA_FILE_PATH: data/collation
         run: |
-          # This file needs to be restored  otherwise GHA cannot
-          # check-out the perfdata branch. Setting up this task with GH lfs
-          # modifies the file but the details of why and how are unknown.
-          git restore --staged tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
-          git restore tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
           cd icu4j;
           mvn ${SHARED_MVN_ARGS} verify -DskipITs -DskipTests;
           cd perf-tests;
@@ -669,7 +649,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Lookup read-only cache of local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -685,11 +665,6 @@ jobs:
         env:
           DATA_FILE_PATH: data/conversion
         run: |
-          # This file needs to be restored  otherwise GHA cannot
-          # check-out the perfdata branch. Setting up this task with GH lfs
-          # modifies the file but the details of why and how are unknown.
-          git restore --staged tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
-          git restore tools/multi/proj/icu4cscan/old-xmls.tar.bz2;
           cd icu4j;
           mvn ${SHARED_MVN_ARGS} verify -DskipITs -DskipTests;
           cd perf-tests;
@@ -752,7 +727,7 @@ jobs:
       - name: Checkout lfs objects
         run: git lfs pull
       - name: Lookup read-only cache of local Maven repository
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@v4.2.0
         with:
           path: ~/.m2/repository
           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
@@ -771,11 +746,6 @@ jobs:
           echo "DDIR=${ddir: -1}" >> $GITHUB_ENV
       - name: Build and run dateformatperf
         run: |
-          # This file needs to be restored  otherwise GHA cannot
-          # check-out the perfdata branch. Setting up this task with GH lfs
-          # modifies the file but the details of why and how are unknown.
-          git restore --staged tools/multi/proj/icu4cscan/old-xmls.tar.bz2
-          git restore tools/multi/proj/icu4cscan/old-xmls.tar.bz2
           cd icu4j;
           mvn ${SHARED_MVN_ARGS} verify -DskipITs -DskipTests;
           cd perf-tests;

.github/workflows/release-icu4c-ubuntu.yml

@@ -60,14 +60,14 @@ jobs:
         source /etc/os-release
         # Get the ICU version in artifact_version
         source icu4j/releases_tools/shared.sh
-        # Convert 76.1 to 76_1
+        # Convert 77.1 to 77_1
         underscore_version=$(echo $artifact_version | sed 's/\./_/g')
         pushd ${RELEASE_FOLDER}
         tar -czf icu4c-${underscore_version}-Ubuntu${VERSION_ID}-x64.tgz icu
         rm -fr icu
         popd
-        mv icu4c/source/dist/icu4c-76_1-d*    ${RELEASE_FOLDER}
-        mv icu4c/source/dist/icu4c-76_1-src.* ${RELEASE_FOLDER}
+        mv icu4c/source/dist/icu4c-77_1-d*    ${RELEASE_FOLDER}
+        mv icu4c/source/dist/icu4c-77_1-src.* ${RELEASE_FOLDER}
 
     - name: Upload build results
       uses: actions/[email protected]

.github/workflows/scorecard.yml

@@ -34,7 +34,7 @@ jobs:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
+        uses: ossf/scorecard-action@f49aabe0b5af0936a0987cfb85d86b75731b0186 # v2.4.1
         with:
           results_file: results.sarif
           results_format: sarif
@@ -59,6 +59,6 @@ jobs:
 
       # Upload the results to GitHub's code scanning dashboard.
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@9b41ced437d4a4f34bf0b740f80b4e52d3c4bccd # v2.25.15
+        uses: github/codeql-action/upload-sarif@83923549f688e42b34d0b90ee94725f7c30532fc # v2.25.15
         with:
           sarif_file: results.sarif

.github/workflows/wait-for-checks.yml

@@ -20,7 +20,7 @@ jobs:
       checks: read
     steps:
     - name: Wait for Triggered Required GH Checks
-      uses: poseidon/wait-for-status-checks@6988432d64ad3f9c2608db4ca16fded1b7d36ead # v0.5.0
+      uses: poseidon/wait-for-status-checks@899c768d191b56eef585c18f8558da19e1f3e707 # v0.6.0
       with:
         token: ${{ secrets.GITHUB_TOKEN }}
         # This regex matches everything since almost all (if not all) CI checks are required.

LICENSE

@@ -2,7 +2,7 @@ UNICODE LICENSE V3
 
 COPYRIGHT AND PERMISSION NOTICE
 
-Copyright © 2016-2024 Unicode, Inc.
+Copyright © 2016-2025 Unicode, Inc.
 
 NOTICE TO USER: Carefully read the following legal agreement. BY
 DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR

docs/devsetup/java/maven.md → docs/devsetup/java/maven/index.md

@@ -110,11 +110,50 @@ These instructions have not yet verified Eclipse's handling of the import of the
 
 ### VS Code
 
-VS Code's support of Maven projects is not as robust as IntelliJ's when it comes to the non-standard file layout for sources and tests.
-The Maven support comes from the standard Java extension (which depends on the standard Maven extension) from the extension marketplace.
+VS Code's support of Maven projects has not been as robust as IntelliJ's when it comes to multi-module Maven projects such as what ICU4J has.
+This situation has gotten better recently, and workable solutions are documented below..
+
+The Maven extension that is mostly likely to top search result comes from [the Extension Pack for Java extension](https://marketplace.visualstudio.com/items?itemName=vscjava.vscode-java-pack) that is maintained by the maintainers of VS Code itself. However, this extension and its dependencies do not work together satisfactorily for the ICU4J codebase.
 Source and test code files are not recognized properly, and it is not clear how to execute the tests.
+This may improve in the future.
+
+For now (Jan 2025), there are a couple of different options for running Maven build commands for ICU4J in VS Code.
+
+#### Install the Java extension from Oracle
+
+Oracle's [Java extension for VS Code](https://marketplace.visualstudio.com/items?itemName=Oracle.oracle-java) includes support for Maven projects, including multi-module Maven projects.
+
+You can view the Java extension's view of the Maven project through the "Projects" tab of the workspace explorer accordion widget.
+The project will display the list of Maven sub-modules.
+Within a submodule, click on "Source Pakcages" to view the Java class packages.
+From there, you can navigate to specific classes according to the package structure.
+
+> :point_right: **Note**: This extension will use the version of Java according to the location of Java that you have defined in your `JAVA_HOME` system environment variable.
+
+> :point_right: **Note**: You will also need the Maven command (`mvn`) in your `PATH` system environment variable for the extension to work.
+
+![](open-sources-uniset.png)
+
+To run all of the tests in a Maven submodule, right-click on the module and selecting "Test Project".
+
+![](run-tests-main-core.png)
+
+To run all of the tests in a single test class, open the test class, and click on the triangular play button on level with the class declaration line. You can right click on that button to run in debug mode and enable other options.
+
+Every individual test will have a similar button on level with the test signature to run only that one test.
+
+![](test-class-run-all-tests.png)
+
+The output for a test run invocation will appear in the Debug Console tab of the bottom panel.
+
+> :point_right: **Note**: In the Test Results tab, if the the formatting of the output that is provided per test is not formatted correctly, it may be related to formatting in the Maven CLI command's output (ex: allowing ANSI color code escape characters, which some system's Maven installtions enable by default).
+
+![](test-class-run-tests-result.png)
+
+#### Run Maven shell commands with a command palette
 
-However, a workaround exists for those who want to use VS Code as their preferred editor and still execute commands to recompile or run tests.
+If none of the Java/Maven extensions for VS Code work with your instance of VS Code,
+there is still a way to execute commands to recompile or run tests.
 The workaround relies on invoking the Maven commands in a shell, and using a VS Code extension to create shortcuts within the IDE to invoke those commands.
 
 The extension is [Command Runner](https://marketplace.visualstudio.com/items?itemName=edonet.vscode-command-runner).