Merge branch 'main' into generate-libraries-main

Author: diegomarquezp

.github/release-note-generation/split_release_note.py

@@ -69,6 +69,7 @@ def detect_modules(root_directory: Path):
         tree = ET.parse(module_pom_xml)
         root = tree.getroot()
         version = root.find('mvn:version', POM_NAMESPACES).text
+        api_name = None
         if owlbot_yaml_path.exists():
             # If OwlBot configuration file exists (most cases), it's the better
             # source to get the OwlBot-generated pull request title prefix than
@@ -78,21 +79,21 @@ def detect_modules(root_directory: Path):
                 match = re.search(r'api-name: (.+)', owlbot_yaml_content)
                 if match:
                     api_name = match.group(1)
-                    modules.append(LibraryModule(module_path, api_name,
-                                                 version,
-                                                 changelog))
+
+        if not api_name:
+            # Fallback to repo-metadata.json (e.g. for vertexai or Spanner transitional state)
+            if repo_metadata_path.exists():
+                with open(repo_metadata_path, 'r') as file:
+                    repo_metadata = json.load(file)
+                    api_name = repo_metadata.get('api_shortname')
+
+        if api_name:
+            modules.append(LibraryModule(module_path, api_name,
+                                         version,
+                                         changelog))
         else:
-            # vertexai (handwritten) does not have OwlBot yaml file
-            with open(repo_metadata_path, 'r') as file:
-                repo_metadata = json.load(file)
-                api_name = repo_metadata['api_shortname']
-                if api_name:
-                    modules.append(LibraryModule(repo_metadata_path.parent, api_name,
-                                                 version,
-                                                 changelog))
-                else:
-                    raise Exception(f'repo_metadata_path {repo_metadata_path} does'
-                                    f' not have api_shortname field')
+            raise Exception(f'Could not determine api-name for {repo_metadata_path}')
+
 
     return modules
 
@@ -133,7 +134,7 @@ def group_changes_by_api(main_changes: [str]):
             elif section == BUG_FIXES_SECTION:
                 api_to_changelog[api_name].bug_fixes.append(note)
             elif section == DEPENDENCIES_SECTION:
-                api_to_changelog[api_name].dependencies.append(note)
+                api_to_changelog[api_name].dependency_upgrades.append(note)
     return api_to_changelog
 
 

.github/release-note-generation/unit_test.py

@@ -1,9 +1,11 @@
 import unittest
+import tempfile
+import json
+from pathlib import Path
 
 # Unit tests for split_release_note.py
 
-from split_release_note import LibraryModule, create_changelog_entry, group_changes_by_api, ChangesOnApi
-from pathlib import Path
+from split_release_note import LibraryModule, create_changelog_entry, group_changes_by_api, ChangesOnApi, detect_modules
 
 dummy_module = LibraryModule(
     Path('release-note-generation/test/java-analyics-admin'),
@@ -81,6 +83,31 @@ def test_group_changes_by_api(self):
                                      ['No change']),
                          ['No change'])
 
+    def test_detect_modules_fallback(self):
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            tmp_path = Path(tmpdirname)
+            module_path = tmp_path / "java-spanner"
+            module_path.mkdir()
+            
+            # Create minimal pom.xml
+            pom_path = module_path / "pom.xml"
+            with open(pom_path, "w") as f:
+                f.write('<project xmlns:mvn="http://maven.apache.org/POM/4.0.0"><mvn:version>1.0.0</mvn:version></project>')
+                
+            # Create .repo-metadata.json with api_shortname
+            metadata_path = module_path / ".repo-metadata.json"
+            with open(metadata_path, "w") as f:
+                json.dump({"api_shortname": "spanner"}, f)
+                
+            # Create CHANGELOG.md
+            changelog_path = module_path / "CHANGELOG.md"
+            changelog_path.touch()
+            
+            modules = detect_modules(tmp_path)
+            self.assertEqual(len(modules), 1)
+            self.assertEqual(modules[0].api_name, "spanner")
+            self.assertEqual(modules[0].version, "1.0.0")
+
 
 if __name__ == "__main__":
     unittest.main()

.github/workflows/ci.yaml

@@ -246,8 +246,28 @@ jobs:
         JOB_TYPE: test
         JOB_NAME: units-8-runtime-${{matrix.java}}
       working-directory: ${{matrix.package}}
+  split-clirr:
+    runs-on: ubuntu-latest
+    needs: changes
+    strategy:
+      matrix:
+        package: ${{ fromJSON(needs.changes.outputs.packages) }}
+    steps:
+    - name: Get current week within the year
+      id: date
+      run: echo "::set-output name=week_of_year::$(date +'%W' --utc)"
+    - uses: actions/checkout@v4
+    - uses: actions/setup-java@v4
+      with:
+        distribution: temurin
+        java-version: 11
+    - run: .kokoro/build.sh
+      env:
+        BUILD_SUBDIR: ${{matrix.package}}
+        JOB_TYPE: clirr
+        JOB_NAME: clirr-${{matrix.package}}
   required:
-    needs: [ changes, split-units ]
+    needs: [ changes, split-units, split-clirr ]
     name: conditional-required-check
     if: ${{ always() }} # Always run even if any "needs" jobs fail
     runs-on: ubuntu-22.04

.github/workflows/google-auth-library-java-ci.yaml

@@ -55,8 +55,24 @@ jobs:
         BUILD_SUBDIR: google-auth-library-java
         JOB_TYPE: test
         SUREFIRE_JVM_OPT: "-P '!slf4j2x,slf4j2x-test'"
+  clirr:
+    needs: filter
+    if: ${{ needs.filter.outputs.library == 'true' }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-java@v3
+      with:
+        distribution: temurin
+        java-version: 11
+    - run: java -version
+    - run: .kokoro/build.sh
+      env:
+        JOB_TYPE: clirr
+        BUILD_SUBDIR: google-auth-library-java
+
   required:
-    needs: [ units-logging ]
+    needs: [ units-logging, clirr ]
     name: conditional-required-check
     if: ${{ always() }} # Always run even if any "needs" jobs fail
     runs-on: ubuntu-22.04

.github/workflows/hermetic_library_generation.yaml

@@ -47,4 +47,5 @@ jobs:
         head_ref: ${{ github.head_ref }}
         token: ${{ secrets.CLOUD_JAVA_BOT_GITHUB_TOKEN }}
         force_regenerate_all: ${{ github.event.pull_request.head.ref == 'generate-libraries-main' }}
+        showcase_mode: true
         image_tag: ${{ env.GENERATOR_VERSION }}

.github/workflows/sdk-platform-java-ci.yaml

@@ -53,6 +53,22 @@ jobs:
           GOOGLE_SDK_JAVA_LOGGING: true
         working-directory: sdk-platform-java
 
+  clirr:
+    needs: filter
+    if: ${{ needs.filter.outputs.library == 'true' }}
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v3
+    - uses: actions/setup-java@v3
+      with:
+        distribution: temurin
+        java-version: 11
+    - run: java -version
+    - run: .kokoro/build.sh
+      env:
+        JOB_TYPE: clirr
+        BUILD_SUBDIR: sdk-platform-java
+
   sdk-platform-java-8:
     needs: filter
     if: ${{ needs.filter.outputs.library == 'true' }}
@@ -284,202 +300,6 @@ jobs:
         echo "All class files are compatible with Java 8."
       working-directory: sdk-platform-java
 
-  build-java8-showcase:
-    needs: filter
-    if: ${{ needs.filter.outputs.library == 'true' }}
-    name: "build(8) for showcase"
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
-        with:
-          java-version: 11
-          distribution: temurin
-          cache: maven
-      - name: Install all modules using Java 11
-        shell: bash
-        run: .kokoro/build.sh
-        env:
-          BUILD_SUBDIR: sdk-platform-java
-          JOB_TYPE: install
-      - uses: actions/setup-java@v3
-        with:
-          java-version: 8
-          distribution: temurin
-      - run: java -version
-      - name: Parse showcase version
-        working-directory: sdk-platform-java/java-showcase/gapic-showcase
-        run: echo "SHOWCASE_VERSION=$(mvn help:evaluate -Dexpression=gapic-showcase.version -q -DforceStdout)" >> "$GITHUB_ENV"
-      - name: Install showcase server
-        run: |
-                sudo mkdir -p /usr/src/showcase
-                sudo chown -R ${USER} /usr/src/
-                curl --location https://github.com/googleapis/gapic-showcase/releases/download/v${{env.SHOWCASE_VERSION}}/gapic-showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz --output /usr/src/showcase/showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz
-                cd /usr/src/showcase/
-                tar -xf showcase-*
-                ./gapic-showcase run &
-                cd -
-      - name: Showcase integration tests
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-              mvn verify \
-                -P enable-integration-tests \
-                --batch-mode \
-                --no-transfer-progress
-        # The `slf4j1_logback` profile brings logging dependency and compiles logging tests, require env var to be set
-      - name: Showcase integration tests - Logging SLF4J 1.x
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-             mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,slf4j1_logback' \
-              --batch-mode \
-              --no-transfer-progress
-        # Set the Env Var for this step only
-        env:
-            GOOGLE_SDK_JAVA_LOGGING: true
-        # The `disabledLogging` profile tests logging disabled when logging dependency present,
-        # do not set env var for this step
-      - name: Showcase integration tests - Logging disabed
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,disabledLogging'  \
-            --batch-mode \
-            --no-transfer-progress
-      - name: Showcase integration tests - Protobuf gen code 3.25.8
-        working-directory: sdk-platform-java/java-showcase-3.25.8
-        run: |
-          mvn verify \
-            -P enable-integration-tests \
-            --batch-mode \
-            --no-transfer-progress
-      - name: Showcase integration tests - Protobuf gen code 3.21.0
-        working-directory: sdk-platform-java/java-showcase-3.21.0
-        run: |
-          mvn verify \
-            -P enable-integration-tests \
-            --batch-mode \
-            --no-transfer-progress
-  showcase:
-    needs: filter
-    if: ${{ needs.filter.outputs.library == 'true' }}
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        java: [ 11, 17, 21, 25 ]
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-java@v4
-        with:
-          java-version: ${{ matrix.java }}
-          distribution: temurin
-      - run: mvn -version
-      - name: Install Maven modules
-        shell: bash
-        run: .kokoro/build.sh
-        env:
-          BUILD_SUBDIR: sdk-platform-java
-          JOB_TYPE: test      
-      - name: Showcase golden tests
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn test \
-            -P enable-golden-tests \
-            --batch-mode \
-            --no-transfer-progress
-      - name: Parse showcase version
-        working-directory: sdk-platform-java/java-showcase/gapic-showcase
-        run: echo "SHOWCASE_VERSION=$(mvn help:evaluate -Dexpression=gapic-showcase.version -q -DforceStdout)" >> "$GITHUB_ENV"
-      - name: Install showcase server
-        run: |
-          sudo mkdir -p /usr/src/showcase
-          sudo chown -R ${USER} /usr/src/
-          curl --location https://github.com/googleapis/gapic-showcase/releases/download/v${{env.SHOWCASE_VERSION}}/gapic-showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz --output /usr/src/showcase/showcase-${{env.SHOWCASE_VERSION}}-linux-amd64.tar.gz
-          cd /usr/src/showcase/
-          tar -xf showcase-*
-          ./gapic-showcase run &
-          cd -
-      - name: Showcase integration tests
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn verify \
-            -P enable-integration-tests \
-            --batch-mode \
-            --no-transfer-progress
-      # The `slf4j2_logback` profile brings logging dependency and compiles logging tests, require env var to be set
-      - name: Showcase integration tests - Logging SLF4J 2.x
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,slf4j2_logback' \
-            --batch-mode \
-            --no-transfer-progress
-        # Set the Env Var for this step only
-        env:
-          GOOGLE_SDK_JAVA_LOGGING: true
-    # The `slf4j1_logback` profile brings logging dependency and compiles logging tests, require env var to be set
-      - name: Showcase integration tests - Logging SLF4J 1.x
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,slf4j1_logback' \
-            --batch-mode \
-            --no-transfer-progress
-        # Set the Env Var for this step only
-        env:
-          GOOGLE_SDK_JAVA_LOGGING: true
-    # The `disabledLogging` profile tests logging disabled when logging dependency present,
-    # do not set env var for this step
-      - name: Showcase integration tests - Logging disabed
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn clean verify -P '!showcase,enable-integration-tests,loggingTestBase,disabledLogging'  \
-            --batch-mode \
-            --no-transfer-progress
-      - name: Showcase integration tests - Protobuf 3 compatibility with third party library Tensorflow
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn clean verify -P 'enable-integration-tests,protobuf3,showcase'  \
-            --batch-mode \
-            --no-transfer-progress
-
-  showcase-clirr:
-    needs: filter
-    if: ${{ (needs.filter.outputs.library == 'true') && github.base_ref != '' }} # Only execute on pull_request trigger event
-    runs-on: ubuntu-22.04
-    steps:
-      - name: Checkout @ target branch
-        uses: actions/checkout@v4
-        with:
-          ref: ${{ github.base_ref }}
-      - uses: actions/setup-java@v4
-        with:
-          java-version: 17
-          distribution: temurin
-          cache: maven
-      - name: Install Maven modules
-        shell: bash
-        run: .kokoro/build.sh
-        env:
-          BUILD_SUBDIR: sdk-platform-java
-          JOB_TYPE: install
-      - name: Install showcase to local maven repository
-        run: |
-          mvn install -B -ntp -T 1C -DskipTests
-          SHOWCASE_CLIENT_VERSION=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
-          echo "SHOWCASE_CLIENT_VERSION=$SHOWCASE_CLIENT_VERSION" >> "$GITHUB_ENV"
-        working-directory: sdk-platform-java/java-showcase
-      - name: Checkout sdk-platform-java @ PR merge commit
-        uses: actions/checkout@v3
-      - name: Install sdk-platform-java @ PR merge commit
-        shell: bash
-        run: .kokoro/build.sh
-        env:
-          JOB_TYPE: install
-          BUILD_SUBDIR: sdk-platform-java
-        # Showcase golden test ensures that src changes are already reflected in the PR.
-      - name: Clirr check
-        working-directory: sdk-platform-java/java-showcase
-        run: |
-          mvn versions:set -B -ntp -DnewVersion=local
-          mvn clirr:check -B -ntp -DcomparisonVersion=$SHOWCASE_CLIENT_VERSION
-
   gapic-generator-java-bom:
     needs: filter
     if: ${{ needs.filter.outputs.library == 'true' }}