Merge pull request #291 from dexhorthy/ui

commit empty ui, update makefile for generating ignored UI

Author: dexhorthy

CONTRIBUTING.md

@@ -0,0 +1,63 @@
+Contributing
+=============
+
+This is a living document and is to be expanded. As of its initial writing, this document's main goal is to create a home for
+intructions pertaining to building and running the project.
+
+Issues
+------------------------
+
+Pull Requests
+------------------------
+
+Build & Run the Project
+------------------------
+
+### Prerequisites
+
+Ensure you have (min versions to be added):
+
+- `yarn`
+- `go`
+- `node`
+
+### First time build
+
+The first time you build ship, you'll need to run the following
+
+```
+make build-ui embed-ui build
+```
+
+If you're planning to only work on "headless" modes, you can omit the `build-ui` and `embed-ui` steps.
+
+### Running
+
+To run your locally-built copy of ship, use
+
+```
+./bin/ship init <chart-path>
+```
+
+for example,
+
+```
+./bin/ship init github.com/helm/charts/stable/nginx-ingress
+```
+
+### Iterating
+
+For iterating on the go (not the UI), you can use
+
+```
+make build
+```
+
+to re-build the project.
+
+For iterating on the ui, you can start a webpack development server with
+
+```
+make -C web serve_ship
+```
+

Makefile

@@ -1,4 +1,4 @@
-.PHONY: build-deps -dep-deps docker shell githooks dep fmt _vet vet _lint lint _test test build e2e run build_yoonit_docker_image _build citest ci-upload-coverage goreleaser integration-test build_ship_integration_test build-ui embed-ui pkg/lifecycle/ui.bindatafs.go
+.PHONY: build-deps -dep-deps docker shell githooks dep fmt _vet vet _lint lint _test test build e2e run build_yoonit_docker_image _build citest ci-upload-coverage goreleaser integration-test build_ship_integration_test build-ui pkg/lifecycle/ui.bindatafs.go embed-ui
 
 
 SHELL := /bin/bash
@@ -234,16 +234,37 @@ build_yoonit_docker_image:
 build_ship_integration_test:
 	docker build -t $(DOCKER_REPO)/ship-e2e-test:latest -f ./integration/Dockerfile .
 
-pkg/lifeycle/daemon/ui.bindatafs.go: .state/build-deps 
-	cd web; go-bindata-assetfs -pkg daemon \
-	  -o ../pkg/lifecycle/daemon/ui.bindatafs.go \
-	  -nometadata \
-	  dist/...
+pkg/lifeycle/daemon/ui.bindatafs.go: .state/build-deps
+	go-bindata-assetfs -pkg daemon \
+	  -o pkg/lifecycle/daemon/ui.bindatafs.go \
+	  -prefix web/ \
+	  web/dist/...
+
+.state/ui-gitignored: 
+	cd pkg/lifecycle/daemon/; git update-index --assume-unchanged ui.bindatafs.go
+	@touch .state/ui-gitignored
+
+mark-ui-gitignored: .state/ui-gitignored
+
+
+embed-ui: mark-ui-gitignored pkg/lifeycle/daemon/ui.bindatafs.go fmt
 
-embed-ui: pkg/lifeycle/daemon/ui.bindatafs.go fmt
 
 build-ui:
 	$(MAKE) -C web build_ship
 
 test_CI:
 	$(MAKE) -C web test_CI
+
+# this shouldn't ever have to be run, but leaving here for
+# posterity on how the go-bindatafs "dev" file was generated
+# before we marked it as ignored. the goal here is to
+# generate an empty bindata fs, so things are obviously wrong
+# rather than folks just getting an old version of the UI
+dev-embed-ui:
+	mkdir -p .state/tmp/dist
+	go-bindata-assetfs -pkg daemon \
+	  -o pkg/lifecycle/daemon/ui.bindatafs.go \
+	  -prefix .state/tmp/ \
+	  -debug \
+	  .state/tmp/dist/...

README.md

@@ -78,4 +78,5 @@ For questions about using Ship, there's a [Replicated Community](https://help.re
 
 For bug reports, please [open an issue](https://github.com/replicatedhq/ship/issues/new) in this repo.
 
+For instructions on building the project and making contributions, see [Contributing](./CONTRIBUTING.md)
 

pkg/lifecycle/daemon/ui.bindatafs.go

@@ -35,6 +35,7 @@ embed_ship:
 	:
 	: Assets embedded. You will need to rebuild ship to see changes reflected
 
+
 test:
 	yarn test