Skip to content

Commit e3a1486

Browse files
committed
fix: address PR feedback and update dataplex changelog
- Update override parser to preserve newlines in multi-line commit messages (e.g., for breaking changes) instead of squashing them into single lines. - Update test suite to use `sys.executable` for cross-platform portability and `capture_output=True` for idiomatic subprocess calls. - Regenerate test goldens to reflect the corrected multi-line markdown output. - Update java-dataplex/CHANGELOG.md to reflect the corrected output.
1 parent 069dac7 commit e3a1486

6 files changed

Lines changed: 151 additions & 52 deletions

File tree

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ def parse_commit_overrides(commit_data, short_name, prefix_regex, commit_hash, c
114114

115115
if is_new_item:
116116
if in_module_item and current_item:
117-
categorize_callback(commit_hash, " ".join(current_item))
117+
categorize_callback(commit_hash, "\n".join(current_item))
118118
current_item = []
119119
in_module_item = False
120120

@@ -136,7 +136,7 @@ def parse_commit_overrides(commit_data, short_name, prefix_regex, commit_hash, c
136136
current_item.append(line_stripped)
137137

138138
if in_module_item and current_item:
139-
categorize_callback(commit_hash, " ".join(current_item))
139+
categorize_callback(commit_hash, "\n".join(current_item))
140140

141141
return True
142142

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

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import subprocess
2+
import sys
23
import unittest
34
from pathlib import Path
45

@@ -17,7 +18,7 @@ def test_java_run_generation(self):
1718
expected_output = f.read()
1819

1920
cmd = [
20-
"python3",
21+
sys.executable,
2122
str(self.script_path),
2223
"--module",
2324
"google-cloud-run",
@@ -29,10 +30,9 @@ def test_java_run_generation(self):
2930
"run",
3031
]
3132
result = subprocess.run(
32-
cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True
33+
cmd, capture_output=True, text=True, check=True
3334
)
3435

35-
self.assertEqual(result.returncode, 0)
3636
self.assertEqual(result.stdout, expected_output)
3737

3838
def test_root_generation(self):
@@ -41,7 +41,7 @@ def test_root_generation(self):
4141
expected_output = f.read()
4242

4343
cmd = [
44-
"python3",
44+
sys.executable,
4545
str(self.script_path),
4646
"--module",
4747
"google-cloud-java",
@@ -51,10 +51,9 @@ def test_root_generation(self):
5151
"1.85.0",
5252
]
5353
result = subprocess.run(
54-
cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True
54+
cmd, capture_output=True, text=True, check=True
5555
)
5656

57-
self.assertEqual(result.returncode, 0)
5857
self.assertEqual(result.stdout, expected_output)
5958

6059

@@ -67,11 +66,10 @@ def test_java_dataplex_generation(self):
6766
"--short-name", "dataplex"
6867
]
6968

70-
cmd = ["python3", str(self.script_path)] + args
69+
cmd = [sys.executable, str(self.script_path)] + args
7170
result = subprocess.run(
72-
cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True
71+
cmd, capture_output=True, text=True, check=True
7372
)
74-
self.assertEqual(result.returncode, 0)
7573

7674
golden_path = self.testdata_dir / "golden_java-dataplex_1.86.0.txt"
7775
with open(golden_path, "r") as f:

.github/release-note-generation/testdata/golden_java-dataplex_1.86.0.txt

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,49 @@
22

33
### ⚠ BREAKING CHANGES
44

5-
* fix(dataplex)!: remove deprecated Explore-related methods and messages from public client libraries Breaking Changes: - Removed ContentService and all associated methods (CreateContent, UpdateContent, DeleteContent, GetContent, ListContent, etc.) and request/response messages. - Removed Environment and Session management methods from DataplexService (CreateEnvironment, UpdateEnvironment, DeleteEnvironment, ListEnvironments, GetEnvironment, ListSessions) and their associated messages. [googleapis/googleapis@69ca7ae](https://github.com/googleapis/googleapis/commit/69ca7ae2e66cd5623cafecc00971ef5397a4b258) ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
5+
* fix(dataplex)!: remove deprecated Explore-related methods and messages
6+
from public client libraries
7+
Breaking Changes:
8+
- Removed ContentService and all associated methods (CreateContent,
9+
UpdateContent, DeleteContent, GetContent, ListContent, etc.) and
10+
request/response messages.
11+
- Removed Environment and Session management methods from
12+
DataplexService (CreateEnvironment, UpdateEnvironment,
13+
DeleteEnvironment, ListEnvironments, GetEnvironment, ListSessions) and
14+
their associated messages.
15+
[googleapis/googleapis@69ca7ae](https://github.com/googleapis/googleapis/commit/69ca7ae2e66cd5623cafecc00971ef5397a4b258) ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
616

717
### Features
818

9-
* feat(dataplex): add DataProductService to manage data products and underlying data assets ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
10-
* feat(dataplex): add MetadataFeed to CatalogService for tracking metadata changes ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
11-
* feat(dataplex): add LookupContext to CatalogService for LLM-generated resource context ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
19+
* feat(dataplex): add DataProductService to manage data products and
20+
underlying data assets ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
21+
* feat(dataplex): add MetadataFeed to CatalogService for tracking metadata
22+
changes ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
23+
* feat(dataplex): add LookupContext to CatalogService for LLM-generated
24+
resource context ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
1225
* feat(dataplex): add support for attaching aspects to EntryLinks ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
13-
* feat(dataplex): add UpdateEntryLink and LookupEntryLinks methods to CatalogService ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
26+
* feat(dataplex): add UpdateEntryLink and LookupEntryLinks methods to
27+
CatalogService ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
1428
* feat(dataplex): support OneTime triggers for DataScan operations ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
1529
* feat(dataplex): add debug query support to Data Quality rules ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
16-
* feat(dataplex): allow selective generation scope for Data Documentation scans ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
30+
* feat(dataplex): allow selective generation scope for Data Documentation
31+
scans ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
1732
* feat(dataplex): add SKIPPED state to DataScan catalog publishing status ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
1833

1934
### Documentation
2035

21-
* docs(dataplex): remove deprecated metadata change warnings in Dataplex Catalog The DataProductService provides APIs to curate and manage collections of data assets as data products, enabling more organized sharing and usage for specific business cases. MetadataFeeds allow users to monitor metadata changes (CREATE, UPDATE, DELETE) within a specified scope (organization, project, or entry group) and publish them to Pub/Sub. CatalogService now includes a LookupContext API to provide LLM-generated context for resources, and enhanced EntryLink management, including the ability to attach aspects. DataScan operations now support a OneTime trigger for single-run scans, and Data Quality rules support DebugQueries to help investigate rule failures by returning diagnostic values. ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
36+
* docs(dataplex): remove deprecated metadata change warnings in Dataplex
37+
Catalog
38+
The DataProductService provides APIs to curate and manage collections of
39+
data assets as data products, enabling more organized sharing and usage
40+
for specific business cases.
41+
MetadataFeeds allow users to monitor metadata changes (CREATE, UPDATE,
42+
DELETE) within a specified scope (organization, project, or entry group)
43+
and publish them to Pub/Sub.
44+
CatalogService now includes a LookupContext API to provide LLM-generated
45+
context for resources, and enhanced EntryLink management, including the
46+
ability to attach aspects.
47+
DataScan operations now support a OneTime trigger for single-run scans,
48+
and Data Quality rules support DebugQueries to help investigate rule
49+
failures by returning diagnostic values. ([e29dd99](https://github.com/googleapis/google-cloud-java/commit/e29dd99559b04de62d2f91792a6352b5ce980438))
2250

.github/release-note-generation/testdata/golden_java-run_0.71.0.txt

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,19 @@
22

33
### ⚠ BREAKING CHANGES
44

5-
* fix!: [run] An existing resource_definition `cloudbuild.googleapis.com/WorkerPool` is removed ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
6-
* fix!: [run] A type of an existing resource_reference option of the field `worker_pool` in message `.google.cloud.run.v2.SubmitBuildRequest` is changed from `cloudbuild.googleapis.com/WorkerPool` to `cloudbuild.googleapis.com/BuildWorkerPool` ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
7-
* fix!: [run] A type of an existing resource_reference option of the field `worker_pool` in message `.google.cloud.run.v2.BuildConfig` is changed from `cloudbuild.googleapis.com/WorkerPool` to `cloudbuild.googleapis.com/BuildWorkerPool` ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
5+
* fix!: [run] An existing resource_definition
6+
`cloudbuild.googleapis.com/WorkerPool` is removed ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
7+
* fix!: [run] A type of an existing resource_reference option of the field
8+
`worker_pool` in message `.google.cloud.run.v2.SubmitBuildRequest` is
9+
changed from `cloudbuild.googleapis.com/WorkerPool` to
10+
`cloudbuild.googleapis.com/BuildWorkerPool` ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
11+
* fix!: [run] A type of an existing resource_reference option of the field
12+
`worker_pool` in message `.google.cloud.run.v2.BuildConfig` is changed
13+
from `cloudbuild.googleapis.com/WorkerPool` to
14+
`cloudbuild.googleapis.com/BuildWorkerPool` ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
815

916
### Features
1017

11-
* feat: [run] Adding new resource tpye run.googleapis.com/WorkerPool. [googleapis/googleapis@0998e04](https://github.com/googleapis/googleapis/commit/0998e045cf83a1307ceb158e3da304bdaff5bb3a) ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
18+
* feat: [run] Adding new resource tpye run.googleapis.com/WorkerPool.
19+
[googleapis/googleapis@0998e04](https://github.com/googleapis/googleapis/commit/0998e045cf83a1307ceb158e3da304bdaff5bb3a) ([9f28cd5](https://github.com/googleapis/google-cloud-java/commit/9f28cd5bcd951333fb2a3847edba015840b5029b))
1220

0 commit comments

Comments
 (0)