boilerplate icon indicating copy to clipboard operation
boilerplate copied to clipboard

Ignore templating some file or directories

Open vDMG opened this issue 1 year ago • 4 comments

First, thanks for open-sourcing this super cool project !

Describe the solution you'd like We need a method to disable the templating for certain files/folders, especially when dealing with components like Helm chart templates that already include Go templates. In such cases, we don't want boilerplate to template them; instead, we need to output them as-is.

Describe alternatives you've considered Not sure there is a clean way to do this but I found this workaround :

hooks:
  after:
  # copy helm templates (necessary because of go templates conflicts)
  - command: cp
    args:
      - -R
      - 'charts/{{"{{"}}.serviceName{{"}}"}}/templates/'
      - "{{ outputFolder }}/charts/{{ .serviceName }}/templates/"
  # copy github action files (necessary because of go templates conflicts)
  - command: cp
    args:
      - -R
      - ".github/workflows/"
      - "{{ outputFolder }}/.github/workflows/"

Additional context I propose to add a property like disable_templating or skip_templating to the boilerplate manifest working the same way skip_files works but instead of skipping them we just copy them as-is.

WDYT ? If you like this proposal i'd love to contribute to the project.

vDMG avatar Mar 06 '24 14:03 vDMG

Did you try skip_files?

brikis98 avatar Mar 06 '24 15:03 brikis98

Did you try skip_files?

Yes, but skip_files ignores those files, and they do not appear in the rendered project. In my case, I want to disable templating, but I need them in the rendered project. So, I simply want to copy/paste them without attempting to template.

vDMG avatar Mar 06 '24 15:03 vDMG

Oh, I gotcha. Sorry, read too quickly, and misunderstood.

A skip_templating feature similar to skip_files makes sense to me! PR welcome.

brikis98 avatar Mar 06 '24 15:03 brikis98

Any chance this can be pushed through? I'd like to use this project for some projects but I have some Ansible scripts that need to be included in the templated project that need to be skipped from templating, similar to @vDMG 's problem. I don't quite understand the workaround, since it doesn't seem like it would avoid boilerplating from trying to template the files inside of the project directory.

comminutus avatar Nov 27 '24 01:11 comminutus