Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(internal/actions): refactor changefinder #7884

Merged
merged 3 commits into from May 5, 2023

Conversation

noahdietz
Copy link
Contributor

@noahdietz noahdietz commented May 5, 2023

Refactors changefinder to support nested submodules i.e. vision/v2.

Changes the default compare the current HEAD against origin/main.

Add a -q quiet mode, all logs will be buffered and dumped in the event of an error.

Add a -dir flag to specify a different root dir than the default of cwd.

Add a -format flag with values plain (stdout, new line delimited), and github (prints github action output). Defaults to plain.

Add a -gh-var flag that accepts the name of the GitHub variable the output should set, defaults to submodules.

This will be able to replace the git-fu used in the apidiff workflow and it can power a "change description" action, basically the inverse of the apidiff workflow that reports the added surfaces.

Try it out by running the following:

cd $GOOGLE_CLOUD_GO
git checkout origin owl-bot-copy
go run ./internal/actions/cmd/changefinder -q

@noahdietz noahdietz requested a review from a team as a code owner May 5, 2023 00:17
@product-auto-label product-auto-label bot added the size: m Pull request size is medium. label May 5, 2023
@quartzmo
Copy link
Member

quartzmo commented May 5, 2023

I wasn't aware of changefinder before this PR. It doesn't appear to have any documentation whatsoever. What do you think about adding a short README or even just a few sentences of function docs for main? The description for this PR has some useful content.

@noahdietz
Copy link
Contributor Author

I wasn't aware of changefinder before this PR. It doesn't appear to have any documentation whatsoever. What do you think about adding a short README or even just a few sentences of function docs for main? The description for this PR has some useful content.

Great idea.

Honestly, I wasn't aware of it either until I started to consider writing the exact same thing and bumped into it while starting to do so :)

@quartzmo
Copy link
Member

quartzmo commented May 5, 2023

I think this module and file are currently orphaned. It was added in #4537 and referenced only in .github/workflows/release-submodule.yaml, which no longer exists.

@noahdietz
Copy link
Contributor Author

I think this module and file are currently orphaned. It was added in #4537 and referenced only in .github/workflows/release-submodule.yaml, which no longer exists.

Well I'm glad it wasn't removed, because it's quite useful!

@quartzmo
Copy link
Member

quartzmo commented May 5, 2023

Can you add your new usage(s) to this PR?

@noahdietz
Copy link
Contributor Author

Can you add your new usage(s) to this PR?

If it is OK, I'd prefer to make that change in a separate PR in case I need to revert it (i.e. i break the apidiff workflow).

@noahdietz
Copy link
Contributor Author

Add a README!

@noahdietz noahdietz added the automerge Merge the pull request once unit tests and other checks pass. label May 5, 2023
@gcf-merge-on-green gcf-merge-on-green bot merged commit 482ff7b into googleapis:main May 5, 2023
8 checks passed
@gcf-merge-on-green gcf-merge-on-green bot removed the automerge Merge the pull request once unit tests and other checks pass. label May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants