feat(gapic-generator): add NullMarked annotation to generated classes

Author: nnicolee

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

@@ -63,16 +63,29 @@ def detect_modules(root_directory: Path):
 
         module_path = repo_metadata_path.parent
         module_pom_xml = module_path / 'pom.xml'
+        owlbot_yaml_path = module_path/ '.OwlBot-hermetic.yaml'
         if not module_pom_xml.exists():
             continue
         tree = ET.parse(module_pom_xml)
         root = tree.getroot()
         version = root.find('mvn:version', POM_NAMESPACES).text
         api_name = None
-        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 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
+            # the repo-metadata.json
+            with open(owlbot_yaml_path, 'r') as file:
+                owlbot_yaml_content = file.read()
+                match = re.search(r'api-name: (.+)', owlbot_yaml_content)
+                if match:
+                    api_name = match.group(1)
+
+        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,
@@ -81,6 +94,7 @@ def detect_modules(root_directory: Path):
         else:
             raise Exception(f'Could not determine api-name for {repo_metadata_path}')
 
+
     return modules
 
 

.github/workflows/java-cloud-bom-release-note-generation.yaml

@@ -13,8 +13,21 @@ name: java-cloud-bom release-notes
 env:
   BUILD_SUBDIR: java-cloud-bom
 jobs:
+  filter:
+    runs-on: ubuntu-latest
+    outputs:
+      library: ${{ steps.filter.outputs.library }}
+    steps:
+    - uses: actions/checkout@v4
+    - uses: dorny/paths-filter@v3
+      id: filter
+      with:
+        filters: |
+          library:
+            - 'java-cloud-bom/**'
   release-note-generation:
-    if: ${{ github.event_name == 'workflow_dispatch' || startsWith(github.event.release.tag_name, 'libraries-bom/') }}
+    needs: filter
+    if: ${{ needs.filter.outputs.library == 'true' }}
     runs-on: ubuntu-latest
     permissions:
       contents: write
@@ -39,10 +52,13 @@ jobs:
         if [ -n "${WORKFLOW_DISPATCH_INPUT}" ]; then
           echo "WORKFLOW_DISPATCH_INPUT: ${WORKFLOW_DISPATCH_INPUT}"
           echo "libraries-bom-version=${WORKFLOW_DISPATCH_INPUT}" >> $GITHUB_OUTPUT
-        elif [[ "${GITHUB_REF}" == *"refs/tags/libraries-bom/v"* ]]; then
-          # Example value of GITHUB_REF: refs/tags/libraries-bom/v26.5.0
+        elif [[ "${GITHUB_REF}" == *"refs/tags/v"* ]]; then
+          # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
+          # Example value of GITHUB_REF: refs/tags/v26.5.0
+          # With the single-component setup of Release Please, the Libraries BOM
+          # version is the version of this repository release.
           echo "GITHUB_REF: ${GITHUB_REF}"
-          VERSION=${GITHUB_REF#*v}
+          VERSION=${GITHUB_REF#refs/*/v}
           echo "libraries-bom-version=${VERSION}" >> $GITHUB_OUTPUT
         else
           echo "Couldn't find the Libraries BOM version. WORKFLOW_DISPATCH_INPUT \
@@ -73,7 +89,7 @@ jobs:
         GH_TOKEN: ${{ github.token }}
     - name: Update the release note with release_note.md
       run: |
-        TAG="libraries-bom/v${LIBRARIES_BOM_VERSION}"
+        TAG="v${LIBRARIES_BOM_VERSION}"
         echo "Updating ${TAG}"
         gh release edit "${TAG}" --notes-file release_note.md
       working-directory: java-cloud-bom/release-note-generation

java-accessapproval/.OwlBot-hermetic.yaml

@@ -0,0 +1,36 @@
+# Copyright 2021 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+deep-remove-regex:
+- "/java-accessapproval/grpc-google-.*/src"
+- "/java-accessapproval/proto-google-.*/src"
+- "/java-accessapproval/google-.*/src"
+- "/java-accessapproval/samples/snippets/generated"
+
+deep-preserve-regex:
+- "/.*google-.*/src/main/java/.*/stub/Version.java"
+- "/.*google-cloud-accessapproval/src/test/java/com/google/cloud/accessapproval/v1/it"
+
+deep-copy-regex:
+- source: "/google/cloud/accessapproval/(v.*)/.*-java/proto-google-.*/src"
+  dest: "/owl-bot-staging/java-accessapproval/$1/proto-google-cloud-accessapproval-$1/src"
+- source: "/google/cloud/accessapproval/(v.*)/.*-java/grpc-google-.*/src"
+  dest: "/owl-bot-staging/java-accessapproval/$1/grpc-google-cloud-accessapproval-$1/src"
+- source: "/google/cloud/accessapproval/(v.*)/.*-java/gapic-google-.*/src"
+  dest: "/owl-bot-staging/java-accessapproval/$1/google-cloud-accessapproval/src"
+- source: "/google/cloud/accessapproval/(v.*)/.*-java/samples/snippets/generated"
+  dest: "/owl-bot-staging/java-accessapproval/$1/samples/snippets/generated"
+
+api-name: accessapproval

java-accessapproval/.repo-metadata.json

@@ -5,7 +5,7 @@
   "api_description": "enables controlling access to your organization's data by Google personnel.",
   "client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-accessapproval/latest/overview",
   "release_level": "stable",
-  "transport": "grpc+rest",
+  "transport": "both",
   "language": "java",
   "repo": "googleapis/google-cloud-java",
   "repo_short": "java-accessapproval",

java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminClient.java

@@ -33,6 +33,7 @@
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
@@ -314,6 +315,7 @@
  *
  * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 public class AccessApprovalAdminClient implements BackgroundResource {
   private final AccessApprovalAdminSettings settings;

java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/AccessApprovalAdminSettings.java

@@ -35,6 +35,7 @@
 import java.io.IOException;
 import java.util.List;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
@@ -88,6 +89,7 @@
  * Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
  * retries.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 public class AccessApprovalAdminSettings extends ClientSettings<AccessApprovalAdminSettings> {
 

java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStub.java

@@ -35,13 +35,15 @@
 import com.google.cloud.accessapproval.v1.UpdateAccessApprovalSettingsMessage;
 import com.google.protobuf.Empty;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
  * Base stub class for the AccessApproval service API.
  *
  * <p>This class is for advanced usage and reflects the underlying API directly.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 public abstract class AccessApprovalStub implements BackgroundResource {
 

java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/AccessApprovalStubSettings.java

@@ -67,6 +67,7 @@
 import java.time.Duration;
 import java.util.List;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
@@ -120,6 +121,7 @@
  * Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
  * retries.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 @SuppressWarnings("CanonicalDuration")
 public class AccessApprovalStubSettings extends StubSettings<AccessApprovalStubSettings> {

java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/GrpcAccessApprovalCallableFactory.java

@@ -34,13 +34,15 @@
 import com.google.longrunning.Operation;
 import com.google.longrunning.stub.OperationsStub;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
  * gRPC callable factory implementation for the AccessApproval service API.
  *
  * <p>This class is for advanced usage.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 public class GrpcAccessApprovalCallableFactory implements GrpcStubCallableFactory {
 

java-accessapproval/google-cloud-accessapproval/src/main/java/com/google/cloud/accessapproval/v1/stub/GrpcAccessApprovalStub.java

@@ -45,13 +45,15 @@
 import java.io.IOException;
 import java.util.concurrent.TimeUnit;
 import javax.annotation.Generated;
+import org.jspecify.annotations.NullMarked;
 
 // AUTO-GENERATED DOCUMENTATION AND CLASS.
 /**
  * gRPC stub implementation for the AccessApproval service API.
  *
  * <p>This class is for advanced usage and reflects the underlying API directly.
  */
+@NullMarked
 @Generated("by gapic-generator-java")
 public class GrpcAccessApprovalStub extends AccessApprovalStub {
   private static final MethodDescriptor<ListApprovalRequestsMessage, ListApprovalRequestsResponse>