Template Subfolder convention in README/existing templates #166
Labels
enhancement
New feature or request
Comments
This was referenced Aug 24, 2023
kevya-google
changed the title
kevya-google
added a commit
that referenced
this issue
Sep 11, 2023
…ion (#180) Addresses #173, also reformats subdirectory contents in accordance to #166. Template structure: ``` $ tree -all . ├── contents │ ├── go.mod │ ├── go.sum │ ├── main.go │ ├── main_test.go │ └── README.md ├── deployments │ ├── config │ │ └── autopush-rest-server.env │ ├── contents │ │ └── Dockerfile │ ├── README.md │ ├── spec.yaml │ └── workflows │ ├── ci-rest-server.yaml │ └── deploy-rest-server.yaml ├── README.md └── spec.yaml ``` Rendered template structure: ``` $ tree -all . ├── Dockerfile ├── .github │ ├── config │ │ └── autopush-rest-server.env │ └── workflows │ ├── ci-rest-server.yaml │ └── deploy-rest-server.yaml ├── go.mod ├── go.sum ├── main.go ├── main_test.go └── README.md ```
chloechien
pushed a commit
that referenced
this issue
Sep 12, 2023
…ion (#180) Addresses #173, also reformats subdirectory contents in accordance to #166. Template structure: ``` $ tree -all . ├── contents │ ├── go.mod │ ├── go.sum │ ├── main.go │ ├── main_test.go │ └── README.md ├── deployments │ ├── config │ │ └── autopush-rest-server.env │ ├── contents │ │ └── Dockerfile │ ├── README.md │ ├── spec.yaml │ └── workflows │ ├── ci-rest-server.yaml │ └── deploy-rest-server.yaml ├── README.md └── spec.yaml ``` Rendered template structure: ``` $ tree -all . ├── Dockerfile ├── .github │ ├── config │ │ └── autopush-rest-server.env │ └── workflows │ ├── ci-rest-server.yaml │ └── deploy-rest-server.yaml ├── go.mod ├── go.sum ├── main.go ├── main_test.go └── README.md ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
TL;DR
Establish a recommended convention of having template files that are intended to be included placed in a subfolder one directory below the spec.yaml. This way, other files that are repo-specific (such as .vscode and .gitignore) or metadata for the template won't need to be excluded as part of the spec.yaml (for example, imagine a README.md for describing how to use the template on the same level as the spec.yaml and another README.md in the template folder meant to be included in the render describing details about the template code). However, this shouldn't be strictly enforced, providing some flexibility to template authors as there could be some templates that have a need for follow up actions, different files for different environments, other layout requirements, etc.
Context: https://docs.google.com/document/d/12iN2g1Idz6fW5ZqaokTmSFZf5kHXaWeewULWy2q5GfE/edit#heading=h.z1xyeclrumgj
Detailed design
No response
Alternatives considered
No response
Additional information
No response
The text was updated successfully, but these errors were encountered: