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

Add BUILD.md Development Guide #1347

Merged
merged 4 commits into from
Apr 6, 2022
Merged

Add BUILD.md Development Guide #1347

merged 4 commits into from
Apr 6, 2022

Conversation

ihcsim
Copy link
Contributor

@ihcsim ihcsim commented Mar 31, 2022

Change Overview

This PR adds the BUILD.md development guide, with instructions on how to test, build and package Kanister locally. It also adds a new check target to the Makefile to do some preliminary dev tools check.

✗ make check                                                                                                                           
* need Go....................... ⚠️
 → version mismatched - got 1.18, need 1.17
* need Docker................... ✅
* need Kubectl.................. ✅

✗ make check
* need Go....................... ✅
* need Docker................... ✅
* need Kubectl.................. ✅

✗ make check  
* need Go...................... ❌
 → Go not installed
* need Docker.................. ❌
 → Docker not installed
* need Kubectl................. ❌
 → Kubectl not installed

Pull request type

Please check the type of change your PR introduces:

  • 🚧 Work in Progress
  • 🌈 Refactoring (no functional changes, no api changes)
  • 🐹 Trivial/Minor
  • 🐛 Bugfix
  • 🌻 Feature
  • 🗺️ Documentation
  • 🤖 Test

Issues

Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
Copy link
Contributor

@viveksinghggits viveksinghggits left a comment

Choose a reason for hiding this comment

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

LGTM

```

The following targets can be used to lint, test and build the Kanister
controller:
Copy link
Contributor

Choose a reason for hiding this comment

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

should we also add steps to build kanctl and kando binaries. If not separately there should be a target that just builds all the binaries.

Copy link
Contributor

Choose a reason for hiding this comment

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

Can be done in a follow up PR 👍🏼

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated build/build.sh in #1355 to build kanctl and kando.

BUILD.md Show resolved Hide resolved
Copy link
Contributor

@pavannd1 pavannd1 left a comment

Choose a reason for hiding this comment

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

LGTM

```

The following targets can be used to lint, test and build the Kanister
controller:
Copy link
Contributor

Choose a reason for hiding this comment

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

Can be done in a follow up PR 👍🏼

Signed-off-by: Ivan Sim <ivan.sim@kasten.io>
@ihcsim ihcsim added the kueue label Apr 5, 2022
@mergify mergify bot merged commit 5cde260 into master Apr 6, 2022
@mergify mergify bot deleted the build.md branch April 6, 2022 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

make check command to check if dependencies needed to build the project are installed.
3 participants