From 89fe5bd4f3df3a36cb75e3395faf9964a85dec01 Mon Sep 17 00:00:00 2001 From: Calvin Loncaric Date: Sat, 19 Dec 2020 13:41:25 -0800 Subject: [PATCH 1/2] Suggest adding a .gitattributes file While working on wbond/package_control_channel#8090, I was surprised to learn that there is a way to exclude files from the final package. --- app/html/docs/submitting_a_package.html | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/app/html/docs/submitting_a_package.html b/app/html/docs/submitting_a_package.html index 13c6f57..f74841a 100644 --- a/app/html/docs/submitting_a_package.html +++ b/app/html/docs/submitting_a_package.html @@ -154,6 +154,15 @@

5. Prepare Your Repository

of your repository will prevent Package Control from keeping your package packed as a .sublime-package file in ST3. +
  • + Add a + .gitattributes + file. If your repository includes any files that are not necessary + for end-users, such as tests, they can be omitted from the package by + setting the export-ignore attribute. You can use + git archive + to test your attributes. +
  • 6. Add Your Repository to the Default Channel

    From 47119344fd12e2bcadbb1da4888fad6d1784b6f7 Mon Sep 17 00:00:00 2001 From: Calvin Loncaric Date: Sat, 16 Jan 2021 13:23:53 -0800 Subject: [PATCH 2/2] Note the implications of using a .gitattributes file --- app/html/docs/submitting_a_package.html | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/app/html/docs/submitting_a_package.html b/app/html/docs/submitting_a_package.html index f74841a..b9ed365 100644 --- a/app/html/docs/submitting_a_package.html +++ b/app/html/docs/submitting_a_package.html @@ -155,13 +155,16 @@

    5. Prepare Your Repository

    package packed as a .sublime-package file in ST3.
  • - Add a + Optionally, add a .gitattributes file. If your repository includes any files that are not necessary for end-users, such as tests, they can be omitted from the package by setting the export-ignore attribute. You can use git archive - to test your attributes. + to test your attributes. Note that this will affect all archives + created for your repo, including the release archives downloadable from + GitHub. If you want to include the tests in those archives, this + solution is not appropriate for you.