updated docs to show 'excludes' param

[AzySir]

Updated Documents to show the "excludes" parameter exists

[AzySir]

@findkim Hey Kim, are we able to get this reviewed and merge if possible please!! - Thanks :)

[Spaider]

@AzySir documentation on excludes is rather concise. There are no examples on regex'es. E.g. I did not find a way to exclude the same dir on any nested level (__pycache__ for Python deployments).
Is there a way to achieve this?

Thanks

[AzySir]

@Spaider what was the parameter you added - could you share some code?

[Spaider]

Here's zip archive definition for AppEngine package with Flask App, written in Python:

data "archive_file" "app_package" {
  type = "zip"
  source_dir = "../python/"
  output_path = "../.deploy/app.zip"
  excludes = ["__pycache__", ".DS_Store"]
}

This way it excludes only top-level __pycache__ directory but not the the directories with the same name but on nested levels down below.

[AzySir]

Not sure on directories to be honest... Isn't pycache a folder?
Is the ".DS_Store" working?

Maybe try these?

excludes = ["__pycache__/*"]
excludes = ["./__pycache__"]

[Spaider]

Please disregard .DS_Store. It is a file with some macOS garbage.
Unfortunately, neither options for ignoring __pycache__ directory worked out.

[AzySir]

@Spaider that's a fair use case. Unfortunately I don't have an answer for you - also I didn't design the functionality. I just created a documentation PR.

I think you want to keep an eye on these (and maybe raise your own) -

Here in issue #62 they are asking for a "**/.git" of set up.

I've asked the question in issue #63 if it's possible to do a "__ pycache __/*" arrangement (for a temporary work around) - however I think this is a feature that might need to be requested.

If you do request it - can you please tag me in it :)

[raymondhardynike]

You can see some examples in the test. Glob/wildcards are not supported. I used to have full regex support when i first added excludes but was asked to change it to what it is today. It just uses relative paths. So you would have to list all of the sub dirs one at a time.

https://github.com/hashicorp/terraform-provider-archive/blob/master/archive/zip_archiver_test.go

[raymondhardynike]

It just checks if relname matches elements in the excludes list.
line 74 of zip_archiver.go

for _, exclude := range excludes {
		if exclude == "" {
			continue
		}

		if exclude == fileName {
			return true
		}
	}
	return false

[manasouza]

@AzySir and @Spaider please take a look at #57 if that could be of any help

[github-actions]

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.