awslabs/benchmark-ai

R.E.S.P.E.C.T Makefile Targets!!!!

Open

#634 opened on Jul 25, 2019

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (6 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (19 stars)
PR merge metrics
 (PR metrics pending)

Description

Let's go through and make sure that everything can be built with make and that they all have these targets:

clean-all -> [build -> test] -> [package -> publish] -> deploy

The brackets indicate where dependencies are allowed. So for build you may build and test For publish, you may depend on making sure publishable artifacts are packaged. The contract for "clean-all" is that it guarantees that there are not superfluous artifacts in the tree. (everyone should have a "clean" but it is not being mandated here).

Please check through all the Makefiles so that they behave appropriately.

  • ./baictl/Makefile
  • ./bff/Makefile
  • ./blackbox-tests/Makefile **
  • ./client-lib/Makefile
  • ./executor/integration_tests/Makefile
  • ./executor/Makefile
  • ./fetcher/integration_tests/Makefile
  • ./fetcher/Makefile
  • ./fetcher/mock-fetcher-job/Makefile **
  • ./fetcher-job/Makefile
  • ./kafka-utils/integration_tests/Makefile
  • ./kafka-utils/Makefile
  • ./metrics-extractor/Makefile
  • ./metrics-pusher/Makefile
  • ./prometheus-kafka-topic-exporter/Makefile
  • ./puller/Makefile
  • ./sm-executor/Makefile
  • ./watcher/Makefile

** make sure that they behave appropriately, and output something that makes sense to the caller

Contributor guide

Research direction
Examine each Makefile listed in the checklist and ensure they define the targets clean all, build, test, package, publish, deploy with proper dependencies as specified. Check that clean all removes all artifacts, build can depend on test, package on build, publish on package, and deploy on publish. Ensure any missing or incorrectly implemented targets are fixed.
Tech stack
None
Domain
build systemdevops
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
MakeGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60