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

refactor: simplify make commands #32

Merged
12 commits merged into from
Aug 23, 2023
Merged

refactor: simplify make commands #32

12 commits merged into from
Aug 23, 2023

Conversation

roberta-dt
Copy link
Collaborator

@roberta-dt roberta-dt commented Aug 15, 2023

Description

This PR refines the make commands to be simpler and I have implemented this by merging old commands into new ones

Files updated are the Makefile and the cloudbuild files accordingly.

How has this been tested?

Please explain how you have tested the new changes.

Checklist

  • I have commented my code, particularly in hard-to-understand areas
  • I have successfully run the E2E tests, and have included the links to the pipeline runs below
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated any relevant documentation to reflect my changes
  • I have assigned a reviewer and messaged them

Pipeline run links:

@roberta-dt roberta-dt requested review from a user and felix-datatonic August 17, 2023 12:44
Makefile Outdated
Comment on lines 53 to 54
targets ?= training serving
build: ## Build and push training/serving container image using Docker. Specify target=<training|serving>
Copy link
Collaborator

Choose a reason for hiding this comment

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

target or targets?

Copy link

Choose a reason for hiding this comment

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

targets - it now accepts a list of targets so you can choose to build both training and serving containers with one command

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
targets ?= training serving
build: ## Build and push training/serving container image using Docker. Specify target=<training|serving>
targets ?= training serving
build: ## Build and push training and/or serving container(s) image using Docker. Specify targets=<training serving> e.g. targets=training or targets=training serving (default)

Copy link

Choose a reason for hiding this comment

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

I think it would need to be targets="training serving" (in quotes) to be interpreted correctly by the shell

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
cloudbuild/pr-checks.yaml Show resolved Hide resolved
Makefile Outdated
$(MAKE) test-components GROUP=$$(basename $$component_group) ; \
done
targets ?= "training serving"
build: ## Build and push training and/or serving container(s) image using Docker. Specify targets=<training serving> e.g. targets=training or targets=training serving (default)
Copy link

Choose a reason for hiding this comment

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

add quotes to the docstring as well e.g. targets=training or targets="training serving" (default)

Copy link

Choose a reason for hiding this comment

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Makefile Outdated Show resolved Hide resolved
@roberta-dt
Copy link
Collaborator Author

/gcbrun

@ghost ghost self-requested a review August 23, 2023 11:06
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

Changes look good - please make sure to go through each of the README files to update any instructions that refer to the make commands

@ghost ghost self-requested a review August 23, 2023 14:23
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

LGTM

@ghost ghost merged commit 7828266 into develop Aug 23, 2023
@felix-datatonic felix-datatonic deleted the refactor/refine-MAKEFILE branch November 13, 2023 17:10
This pull request was closed.
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