From 80361f3c82d19bcb2ea8187ccc7d6313dc4c261d Mon Sep 17 00:00:00 2001 From: Nathan Franke Date: Tue, 19 Jul 2022 15:12:23 -0500 Subject: [PATCH] Simplify `.gitattributes` in Submitting to the Asset Library (#5908) --- .../asset_library/submitting_to_assetlib.rst | 37 ++++++++++--------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/community/asset_library/submitting_to_assetlib.rst b/community/asset_library/submitting_to_assetlib.rst index 07eaf78e7..dbfdd20cb 100644 --- a/community/asset_library/submitting_to_assetlib.rst +++ b/community/asset_library/submitting_to_assetlib.rst @@ -80,27 +80,30 @@ library a better place for all users. * Consider adding a **.gitattributes** file to your repo. This file allows giving extra instructions to Git, such as specifying line endings and listing files not required for your asset to function with the ``export-ignore`` - directive. This directive removes such files from the resulting ZIP file - and prevents them from being downloaded by the asset library users. - For a typical plugin **.gitattributes** may look like this: + directive. This directive removes such files from the resulting ZIP file, + preventing them from being downloaded by the asset library users. + These are common examples of **.gitattributes**: - .. code-block:: none + .. tabs:: - # Normalize EOL for all files that Git considers text files. - * text=auto eol=lf + .. tab:: Projects / Templates - # Ignore some files when exporting to a ZIP. - /.gitattributes export-ignore - /.gitignore export-ignore - /LICENSE export-ignore - /LICENSE.md export-ignore - /README.md export-ignore - /project.godot export-ignore - /icon.png export-ignore - /icon.svg export-ignore + .. code-block:: shell - Other types of assets may require a different configuration (e.g. - a project template requires **project.godot**). + # Normalize line endings for all files that Git considers text files. + * text=auto eol=lf + + .. tab:: Addons / Asset Packs + + .. code-block:: shell + + # Normalize line endings for all files that Git considers text files. + * text=auto eol=lf + + # Only include the addons folder when downloading from the Asset Library. + /** export-ignore + /addons !export-ignore + /addons/** !export-ignore * If you are submitting a plugin, add a **copy** of your license and readme to the plugin folder itself. This is the folder that users are guaranteed to