Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

Separate graph generation from make tidy, add make target docs #233

Merged
merged 2 commits into from
Jul 23, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,27 @@ We gratefully welcome improvements to documentation as well as to code.
## Guidelines

TODO: Add contributing guidelines here after we formalize them.

## Make targets

To compile the `ignite` binary, run
```
make
```

To compile the `ignite-spawn` binary and build the Docker image, run
```
make ignite-spawn
```

Before submitting a PR, run
```
make tidy
```

Other targets:
- Install the `ignite` binary: `make install`
- (Re)generate autogenerated content: `make autogen`
- Generate dependency graph: `make graph`
- Depends on `sfdp` (usually found in the `graphviz` package)
- Push the `weaveworks/ignite` Docker image: `make image-push`
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,11 @@ tidy: $(API_DOCS)
gofmt -s -w pkg cmd
goimports -w pkg cmd
hack/generate-client.sh
hack/graph.sh
go run hack/cobra.go

graph:
hack/graph.sh

.PHONY: $(API_DOCS)
$(API_DOCS): api/%.md: $(CACHE_DIR)/go/bin/godoc2md
mkdir -p $$(dirname $@) bin/tmp/$*
Expand Down