chore(librarian): onboard google-cloud-workflows to Librarian (#14604)

This PR onboards the `google-cloud-workflows` package to librarian. Note
that this package contains overlapping api-paths which requires the
following:

- Allow the cli tool to copy code into `owl-bot-staging` even if the
directory exists.
- Ensure that the order of the api paths is not changed i.e. the
`google/cloud/workflows/executions` api paths are followed by
`google/cloud/workflows/` api paths in `state.yaml` file.

For the latter point, this solution is consistent to how the config is
specified in `.Owlbot.yaml` to allow the post processor to override and
use the correct package name in files such as `setup.py`.

We may not need to care about the order of the api paths if the module
name is specified as `google.cloud.workflows` for the executions api in
its `BUILD.bazel` file. Alternatively, this can be passed down as a
generator option to protoc in `.generator/cli.py`. This means that we'll
need to hardcode such api paths within this file and add conditional
logic which adds a little more complexity. This solution is more robust
but can be done as a follow up if needed.

Towards googleapis/librarian#762 🦕

Author: ohmayr

.generator/cli.py

@@ -741,7 +741,7 @@ def _stage_gapic_library(tmp_dir: str, staging_dir: str) -> None:
     """
     # For GAPIC, the generator output is flat in `tmp_dir` and includes all
     # necessary files like setup.py, client library, etc.
-    shutil.copytree(tmp_dir, staging_dir)
+    shutil.copytree(tmp_dir, staging_dir, dirs_exist_ok=True)
 
 
 def _generate_api(
@@ -775,7 +775,9 @@ def _generate_api(
         _run_protoc_command(command, source)
 
         # 3. Determine staging location
-        staging_child_directory = _get_staging_child_directory(api_path, is_proto_only_library)
+        staging_child_directory = _get_staging_child_directory(
+            api_path, is_proto_only_library
+        )
         staging_dir = os.path.join(
             output, "owl-bot-staging", library_id, staging_child_directory
         )

.generator/test_cli.py

@@ -1440,4 +1440,6 @@ def test_stage_gapic_library(mocker):
     _stage_gapic_library(tmp_dir, staging_dir)
 
     # Assertion: Check copytree was called exactly once with the correct arguments
-    mock_shutil_copytree.assert_called_once_with(tmp_dir, staging_dir)
+    mock_shutil_copytree.assert_called_once_with(
+        tmp_dir, staging_dir, dirs_exist_ok=True
+    )

.librarian/state.yaml

@@ -1756,3 +1756,24 @@ libraries:
     remove_regex:
       - packages/google-cloud-data-fusion
     tag_format: '{id}-v{version}'
+  - id: google-cloud-workflows
+    version: 1.18.2
+    last_generated_commit: d300b151a973ce0425ae4ad07b3de957ca31bec6
+    apis:
+      - path: google/cloud/workflows/executions/v1
+      - path: google/cloud/workflows/executions/v1beta
+      - path: google/cloud/workflows/v1
+      - path: google/cloud/workflows/v1beta
+    source_roots:
+      - packages/google-cloud-workflows
+    preserve_regex:
+      - packages/google-cloud-workflows/CHANGELOG.md
+      - docs/CHANGELOG.md
+      - docs/README.rst
+      - samples/README.txt
+      - scripts/client-post-processing
+      - samples/snippets/README.rst
+      - tests/system
+    remove_regex:
+      - packages/google-cloud-workflows
+    tag_format: '{id}-v{version}'

scripts/configure_state_yaml/packages_to_onboard.yaml

@@ -105,6 +105,7 @@ packages_to_onboard: [
   "google-cloud-vpc-access",
   "google-cloud-webrisk",
   "google-cloud-websecurityscanner",
+  "google-cloud-workflows",
   "google-cloud-workstations",
   "googleapis-common-protos",
 ]