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: remove release-please in generated README.md #3289

Merged
merged 5 commits into from
Oct 10, 2024

Conversation

JoeWang1127
Copy link
Collaborator

In this PR:

  • Remove release-please settings in README.md template because the version is managed by hermetic build.

@product-auto-label product-auto-label bot added the size: xs Pull request size is extra small. label Oct 7, 2024
@product-auto-label product-auto-label bot added size: m Pull request size is medium. and removed size: xs Pull request size is extra small. labels Oct 8, 2024
@JoeWang1127 JoeWang1127 marked this pull request as ready for review October 8, 2024 15:45
@JoeWang1127 JoeWang1127 requested a review from blakeli0 October 8, 2024 15:45
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why do we need a repo-metadata.json file for testing README?
If we need info from this file, can they be mocked within the unit test itself? If it's too hard to mock within the unit tests, can we add a comment to the test to reference this file? Otherwise it is not obvious for other developers to know that the test consumes the data from this file.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The repo-metadata.json is loaded in

I think we can refactor this part so that all templates can be rendered without reading .repo-metadata.json, however, this should be a separate PR.

I'll add a comment about .repo-metadata.json.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Can we move this golden file to a different folder? Assuming .repo-metadata.json is the input of the tests, it's weird to have both input and output in the same folder. Judging by the folder name fixtures, it's probably better suited for the test set up data, not the golden files.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done, I moved the golden file to testdata, where has all golden files associated with owlbot tests.

Copy link

sonarqubecloud bot commented Oct 9, 2024

Copy link

sonarqubecloud bot commented Oct 9, 2024

Quality Gate Passed Quality Gate passed for 'java_showcase_integration_tests'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@JoeWang1127 JoeWang1127 requested a review from blakeli0 October 9, 2024 22:06
@JoeWang1127 JoeWang1127 merged commit cd25b40 into main Oct 10, 2024
34 of 35 checks passed
@JoeWang1127 JoeWang1127 deleted the chore/remove-release-please-in-readme branch October 10, 2024 15:20
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.

2 participants