Skip to content

clean up makefile and CI targets #6

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

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

BlaineEXE
Copy link
Contributor

@BlaineEXE BlaineEXE commented Jan 17, 2025

Clean up the top-level Makefile in anticipation for integrating more targets with prow.

Prow e2e tests will be driven by a script in hack
instead of a make target because prow will need special setup compared to user envs that are more flexible. Currently the script is a non-functional placeholder to ensure prow integration can be done without worrying about the script having unexpected bugs. A future PR will follow up to fill in the e2e script, which can be debugged at that time.

Similarly, a placeholder script was created for checking that code/file generation scripts were run by contributors that can be debugged after prow integration.

There was a minor bug running make codegen that was fixed. Documentation was removed from tool targets to ensure make help output is kept small to help new contributors.


After this PR, prow config will be updated to run these tests:

  • Unit tests: make test
  • Linters: make lint
  • Build check: make build (or make all if we think build should run codegen steps)
  • E2e: ./hack/prow-e2e.sh
  • Verify generated files: ./hack/prow-check-generate.sh

After Prow is updated and runs with new PRs, we can add content to ./hack/prow-e2e.sh and ./hack/prow-check-generate.sh. If we add content to these files now, we don't know if there will be errors running them, and prow config might not pass its own CI.

Clean up the top-level Makefile in anticipation for integrating more
targets with prow.

Prow e2e tests will be driven by a script in hack
instead of a make target because prow will need special setup compared
to user envs that are more flexible. Currently the script is a
non-functional placeholder to ensure prow integration can be done
without worrying about the script having unexpected bugs. A future PR
will follow up to fill in the e2e script, which can be debugged at that
time.

Similarly, a placeholder script was created for checking that
code/file generation scripts were run by contributors that can be
debugged after prow integration.

There was a minor bug running `make codegen` that was fixed.
Documentation was removed from tool targets to ensure `make help` output
is kept small to help new contributors.

Signed-off-by: Blaine Gardner <[email protected]>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 17, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: BlaineEXE

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 17, 2025
@BlaineEXE
Copy link
Contributor Author

make help looks like this after changes

image

@shanduur
Copy link
Member

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 22, 2025
@k8s-ci-robot k8s-ci-robot merged commit f93df96 into kubernetes-sigs:main Jan 22, 2025
4 checks passed
@BlaineEXE BlaineEXE deleted the prow-targets branch February 14, 2025 19:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants