chore: add workflow to update the root changelog#10834
Conversation
| # TODO : REMOVE THIS SECTION ONCE THE PR IS APPROVE. THIS IS FOR TESTING PURPOSES | ||
| pull_request: | ||
| branches: [ main ] |
There was a problem hiding this comment.
This is for testing purposes and will be removed once the PR is merged
|
@vchudnov-g Please could you take a look? See the PR generated using this workflow here: https://github.com/googleapis/google-cloud-python/pull/11433/files |
vchudnov-g
left a comment
There was a problem hiding this comment.
PTAL suggestion to add version number
| output+="[$package_dir]("$PACKAGES_URL/$package_dir"/CHANGELOG.md)\n" | ||
| done | ||
|
|
||
| echo -e $output > $SCRIPT_ROOT/../CHANGELOG.md |
There was a problem hiding this comment.
So to confirm, looking at https://github.com/googleapis/google-cloud-python/pull/10836/files: we're explicitly and intentionally getting rid of the single repo-wide numbering, yes? Why did we have it before? Was it simply something we always intended to fix and never got to?
I agree that what you do in this PR makes more sense; just wondering about context and possible unintended consequences.
There was a problem hiding this comment.
I'm not aware of how the single repo-wide numbering was configured previously. We haven't used it since we've migrated back to the monorepo.
|
|
||
| for package in $SCRIPT_ROOT/../packages/*/ ; do | ||
| package_dir=$(basename $package) | ||
| output+="[$package_dir]("$PACKAGES_URL/$package_dir"/CHANGELOG.md)\n" |
There was a problem hiding this comment.
I think it would be helpful if we could list the current version number for each package:
[$package_dir $package_version]($changelog_url)
Not a blocker, and certainly we could do this with a chaser PR, but it might be simple enough to do now and just have it done.
This PR adds a workflow to update CHANGELOG.md automatically when new packages are added. See the output of the script below and an example of a PR here which will be created automatically when there are changes.
Contents of CHANGELOG.md
Please refer to each API's
CHANGELOG.mdfile under thepackages/directoryChangelogs
google-apps-script-type
google-cloud-contentwarehouse
google-cloud-datacatalog-lineage
google-cloud-discoveryengine
google-cloud-enterpriseknowledgegraph
google-cloud-vmwareengine
google-geo-type
google-maps-addressvalidation
google-maps-mapsplatformdatasets
google-maps-routing