Feature Request: Ignore paths when creating hosted artifact

[freakinhippie]

I have many modules which are relatively small in terms of raw terraform code, but have documentation and tests included which are often multiple times the content.

It would be great if terrareg had something like the .gitignore file (possibly .tfmodignore or just .tfignore) which would exclude some portion of the module's contents from the generated artifacts when hosting them rather than using a git url.

For example, consider the following simplified illustration:

>  tree -a my-module
my-module
├── CHANGELOG.md
├── data.tf
├── docs
│   ├── advanced_usage.md
│   ├── basic_usage.md
│   └── images
│       └── overview.svg
├── examples
│   └── defaults
│       └── main.tf
├── .git # truncated for brevity
├── .gitignore
├── main.tf
├── modules
│   └── sub
│       └── main.tf
├── _module_version_.tf
├── outputs.tf
├── README.md
├── terratests
│   ├── basics_test.go
│   ├── go.mod
│   └── go.sum
├── tests
│   ├── 00_input_validation.tftest.hcl
│   └── 05_basics.tftest.hcl
├── .tfignore
├── variables.tf
└── versions.tf

The only portion that must be served to terraform are these:

>  tree -a my-module
my-module
├── data.tf
├── main.tf
├── modules
│   └── sub
│       └── main.tf
├── _module_version_.tf
├── outputs.tf
├── variables.tf
└── versions.tf

So, if I could create a .tfignore file which follows the same rules as .gitignore, then I could include this to achieve the desired results:

my-module/.tfignore:

README.md
CHANGELOG.md
.git
.gitignore
docs/
examples/
terratests/
tests/

And I guess it would make sense for it to automatically ignore itself, but I wouldn't object to having to make that explicit.

[freakinhippie]

Hmm, this seems to be basically a duplicate of #41

[Edit] On further inspection, it is not the same. That request was to use a sort of base path to create the archive from.

[MatthewJohn]

Created gitlab issue: https://gitlab.dockstudios.co.uk/pub/terrareg/-/issues/561
gitlab-issue-id:561

[MatthewJohn]

Interesting! I like this idea.

[MatthewJohn]

Fortunately, I've found a parser that supports these kinds of formats (because, whilst it would be interesting to write, it's something that would likely have so many teething issues and unforeseen use-cases).
I don't want to regret this, but since you raised the issue, what do you think you'd like the ignore file to be named? :P

Some I was thinking:

.tfignore
.terraregignore
.tfmoduleignore
.terraform_or_opentofu-module.ignore_:eyes:

[MatthewJohn]

Oh, I see you already suggested .tfmodigore and .tfignore.. so let's go with .tfignore :)