feat(template): remove rarely used template files (#106)

Signed-off-by: Steffen Exler <Steffen.Exler@mail.schwarz>
SchwarzIT · Apr 30, 2022 · 888b843 · 888b843
1 parent 94d2c5b
commit 888b843
Show file tree

Hide file tree

Showing 10 changed files with 7 additions and 22 deletions.
diff --git a/_template/.dockerignore b/_template/.dockerignore
@@ -13,11 +13,9 @@ out/
 
 # docs
 api/
-docs/
 **/*.md
 
 # other files not needed for build
-deployments/
 .editorconfig
 .golangci.yml
 Makefile

diff --git a/_template/assets/.gitkeep b/_template/assets/.gitkeep
diff --git a/_template/configs/.gitkeep b/_template/configs/.gitkeep
diff --git a/_template/deployments/.gitkeep b/_template/deployments/.gitkeep
diff --git a/_template/docs/architecture/0001-record-architecture-decisions.md b/_template/docs/architecture/0001-record-architecture-decisions.md
diff --git a/_template/internal/.gitkeep b/_template/internal/.gitkeep
diff --git a/_template/internal/README.md b/_template/internal/README.md
@@ -0,0 +1,3 @@
+# `/internal`
+
+Private application and library code. This is the code you don't want others importing in their applications or libraries. Note that this layout pattern is enforced by the Go compiler itself. See the Go 1.4 [`release notes`](https://golang.org/doc/go1.4#internalpackages) for more details. Note that you are not limited to the top level `internal` directory. You can have more than one `internal` directory at any level of your project tree.
diff --git a/_template/pkg/.gitkeep b/_template/pkg/.gitkeep
diff --git a/_template/pkg/README.md b/_template/pkg/README.md
@@ -0,0 +1,3 @@
+# `/pkg`
+
+Library code that's ok to use by external applications (e.g., `/pkg/mypubliclib`). Other projects will import these libraries expecting them to work, so think twice before you put something here :-) Note that the `internal` directory is a better way to ensure your private packages are not importable because it's enforced by Go. The `/pkg` directory is still a good way to explicitly communicate that the code in that directory is safe for use by others. The [`I'll take pkg over internal`](https://travisjeffery.com/b/2019/11/i-ll-take-pkg-over-internal/) blog post by Travis Jeffery provides a good overview of the `pkg` and `internal` directories and when it might make sense to use them.
diff --git a/embed_gen.go b/embed_gen.go
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# `/internal`

		Private application and library code. This is the code you don't want others importing in their applications or libraries. Note that this layout pattern is enforced by the Go compiler itself. See the Go 1.4 [`release notes`](https://golang.org/doc/go1.4#internalpackages) for more details. Note that you are not limited to the top level `internal` directory. You can have more than one `internal` directory at any level of your project tree.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# `/pkg`

		Library code that's ok to use by external applications (e.g., `/pkg/mypubliclib`). Other projects will import these libraries expecting them to work, so think twice before you put something here :-) Note that the `internal` directory is a better way to ensure your private packages are not importable because it's enforced by Go. The `/pkg` directory is still a good way to explicitly communicate that the code in that directory is safe for use by others. The [`I'll take pkg over internal`](https://travisjeffery.com/b/2019/11/i-ll-take-pkg-over-internal/) blog post by Travis Jeffery provides a good overview of the `pkg` and `internal` directories and when it might make sense to use them.