Skip to content

chore: add workflow to update the root changelog#10834

Merged
parthea merged 11 commits into
mainfrom
add-script-to-update-changelog
Jun 23, 2023
Merged

chore: add workflow to update the root changelog#10834
parthea merged 11 commits into
mainfrom
add-script-to-update-changelog

Conversation

@parthea

@parthea parthea commented Feb 3, 2023

Copy link
Copy Markdown
Contributor

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.md file under the packages/ directory

Changelogs

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

@parthea parthea requested a review from a team February 3, 2023 12:24
@parthea parthea changed the title chore: add script to update changelog chore: add workflow to update changelog Feb 3, 2023
@parthea parthea changed the title chore: add workflow to update changelog chore: add workflow to update the root changelog Feb 3, 2023
Comment thread .github/workflows/updatechangelog.yml Outdated
Comment on lines +23 to +25
# TODO : REMOVE THIS SECTION ONCE THE PR IS APPROVE. THIS IS FOR TESTING PURPOSES
pull_request:
branches: [ main ]

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for testing purposes and will be removed once the PR is merged

@parthea

parthea commented Jun 23, 2023

Copy link
Copy Markdown
Contributor Author

@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 vchudnov-g left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PTAL suggestion to add version number

Comment thread scripts/updatechangelog.sh Outdated
output+="[$package_dir]("$PACKAGES_URL/$package_dir"/CHANGELOG.md)\n"
done

echo -e $output > $SCRIPT_ROOT/../CHANGELOG.md

@vchudnov-g vchudnov-g Jun 23, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread scripts/updatechangelog.sh Outdated

for package in $SCRIPT_ROOT/../packages/*/ ; do
package_dir=$(basename $package)
output+="[$package_dir]("$PACKAGES_URL/$package_dir"/CHANGELOG.md)\n"

@vchudnov-g vchudnov-g Jun 23, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 1ca3269

@parthea parthea merged commit eba8805 into main Jun 23, 2023
@parthea parthea deleted the add-script-to-update-changelog branch June 23, 2023 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants