Feature request: add a way to delete files in the output folder about addonfactory-ucc-generator HOT 9 CLOSED

@livehybrid This feature is not documented and not widely used from what I've seen.

I think we can even deprecate it and instead suggest using additional_packaging.py (which is at least mentioned in the documentation). You can achieve the same by deleting unnecessary files using additional_packaging.py.

What do you think?

from addonfactory-ucc-generator.

And if you can share what files are you trying to ignore?

from addonfactory-ucc-generator.

It would be a shame to lose this functionality when it 99% works already, just needs a small edit.
The .uccignore format follows the format of others similar files (such as .slimignore/.gitignore/.dockerignore etc) so makes sense to keep it like this?

from addonfactory-ucc-generator.

@livehybrid Can you share your use case? What files are you trying to ignore?

Reasons behind deleting it are:

• it is not documented
• it is not widely used
• you can achieve the same by using additional_packaging.py

from addonfactory-ucc-generator.

Currently we create a version of apps for testing, some for internal use and some for external publishing. Some versions have specific things removed such as eventgen.conf,pytest-splunk-addon-data.conf and samples depending on the audience.
We could implement this with additional-packaging.py, but would do so by taking the existing code from the ucc-gen app (but with the proposed fix).

It would be nice to retain this functionality that is familiar for users of other systems such as git/docker/slim etc (as this follows the same pattern), but may have to update our existing apps to use a different approach if this is removed.

Thanks

from addonfactory-ucc-generator.

I had a chat with @rfaircloth-splunk and now I understand the issue and why do you have eventgen.conf, pytest-splunk-addon-data.conf and other files in .uccignore file.

ucc-gen got this feature because we had the same issue, but we store pytest-splunk-addon-data.conf and samples in other folders right now, so we are not using it anymore.

Let me work on a fix and tests for it.

from addonfactory-ucc-generator.

More internal discuessions, which is a reminder of the consequences of having undocumented temporary features. The original purpose of this file was to prevent the ucc-gen from using current templates for generated files while we were consolidating code and doing other cleanup activities. The ask here is actually a missing feature that closely resembles this one. Sorry @arys-splunk I lead you astray on this one.

• close the current PR you have add a new PR with similar code as a new function, with the ".uccignorepackage" as the source file instead. Document both where the the current feature is "Trust the developer don't replace template files" and the new feature is "don't include in output"

from addonfactory-ucc-generator.

After clarifying one more time with Ryan, we need to have 2 files:

1. .uccignore - if you add a file there - it means that ucc-gen should not rewrite this file with it's own content, example - import_declare_test.py with changes that you do not want to lose.
2. .uccpackageignore - tell ucc-gen not to specific file / folder to the "output" directory, example - eventgen.conf.

.uccignore has misleading name, which suggest one thing, but initially was implemented as other feature and not documented.

from addonfactory-ucc-generator.

I am documenting .uccignore feature, it will be available in v5.32.0.

from addonfactory-ucc-generator.