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

Makefile: add api-docs to bundle rule #2544

Merged
merged 1 commit into from
Jan 22, 2024

Conversation

frzifus
Copy link
Member

@frzifus frzifus commented Jan 18, 2024

Description:

Link to tracking Issue:

Testing:

Documentation:

@frzifus frzifus added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jan 18, 2024
@frzifus frzifus force-pushed the fix_api_doc_verification branch 2 times, most recently from 5764d48 to a5162bd Compare January 18, 2024 19:07
@frzifus frzifus changed the title test Makefile: add api-docs to generate rule Jan 18, 2024
@frzifus frzifus marked this pull request as ready for review January 18, 2024 19:08
@frzifus frzifus requested a review from a team January 18, 2024 19:08
Makefile Outdated
@@ -192,7 +192,7 @@ lint: golangci-lint

# Generate code
.PHONY: generate
generate: controller-gen
generate: api-docs controller-gen
Copy link
Member

Choose a reason for hiding this comment

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

the api-docs traget was remvoed from generate to improve developer UX by minimizing local changes when developing the operator. #2421

Copy link
Contributor

Choose a reason for hiding this comment

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

Was that actually necessary? api-docs is a noop if you haven't made any changes impacting the docs, so it should be fine to have it here.

Copy link
Member

Choose a reason for hiding this comment

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

What does the generate update? Is it the deepcopy?

I think the api-docs generate should be bundled with the target to generate CRD

Copy link
Contributor

Choose a reason for hiding this comment

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

generate only generates the deepcopy code, yes.

Copy link
Contributor

Choose a reason for hiding this comment

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

But I do agree that api-docs should be a part of bundle rather than generate.

@frzifus frzifus force-pushed the fix_api_doc_verification branch from a5162bd to 6612838 Compare January 19, 2024 22:55
@jaronoff97 jaronoff97 changed the title Makefile: add api-docs to generate rule Makefile: add api-docs to bundle rule Jan 22, 2024
@jaronoff97 jaronoff97 merged commit 4c912b7 into open-telemetry:main Jan 22, 2024
27 checks passed
ItielOlenick pushed a commit to ItielOlenick/opentelemetry-operator that referenced this pull request May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants