Skip to content

Commit 65f2d4c

Browse files
author
chrislovecnm
committed
Updated documentation with development notes
It took me a bit to figure out the correct make sequence, so I added a simple note about it. I also added a new make target for simplicity sake.
1 parent 348549a commit 65f2d4c

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ generate_docs:
9696
generate:
9797
@source test/make.sh && generate
9898

99+
.PHONY: dev
100+
dev: generate generate_docs
101+
@echo "Updated files"
102+
99103
# Versioning
100104
.PHONY: version
101105
version:

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,9 @@ To more cleanly handle cases where desired functionality would require complex d
233233

234234
The root module is generated by running `make generate`. Changes to this repository should be made in the [`autogen`](/autogen) directory where appropriate.
235235

236+
Note: The correct sequence to update the repo using autogen funcationality is the run `make generate && make generate_docs`. This
237+
will create the various terraform files, and then generate the terraform documentation using `terraform-docs`.
238+
236239
## Testing
237240

238241
### Requirements

0 commit comments

Comments
 (0)