Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,17 @@
# By accessing, using, copying or modifying this work you indicate your
# agreement to the Shotgun Pipeline Toolkit Source Code License. All rights
# not expressly granted therein are reserved by Shotgun Software Inc.

# Handle line endings automatically for files detected as text
# and leave all files detected as binary untouched.
* text=auto

# Force the following filetypes to have unix eols, so Windows does not break them
*.pickle binary
# The git executable expects packed-refs to always have LF line endings, even on
# Windows.
**/packed-refs text eol=lf

# We don't want CRLF conversion or any automatic change in there
tests/python/third_party/** binary
# LFS
requirements/**/*.zip filter=lfs diff=lfs merge=lfs -text
python/tank/**/resources_rc.py filter=lfs diff=lfs merge=lfs -text
*.ttf filter=lfs diff=lfs merge=lfs -text
2 changes: 1 addition & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ resources:
- repository: templates
type: github
name: shotgunsoftware/tk-ci-tools
ref: refs/heads/master
ref: refs/heads/ticket/SG-44731-use-git-lfs # TEMP until tk-ci-tools is merged
endpoint: shotgunsoftware

# We want builds to trigger for 3 reasons:
Expand Down
13 changes: 13 additions & 0 deletions docs/descriptor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,12 @@ descriptor is defined as the most recent commit for a given branch.
app download. The git executable is, however, not needed during descriptor
resolve and normal operation.

.. note:: If a repository uses `Git LFS <https://git-lfs.com>`_ to store some of its files
(declared via ``filter=lfs`` entries in its ``.gitattributes``), the machine
downloading the descriptor also needs ``git-lfs`` installed and initialized
(``git lfs install``). If it isn't, Toolkit will raise an error rather than
silently checking out files that still contain unresolved LFS pointer text.


Tracking against releases on Github
===================================
Expand Down Expand Up @@ -357,6 +363,13 @@ A token must be set as environment variable that is specific to the organization

.. note:: For private repos, it's recommended that you use a personal access token (classic) with read-only access to Content. Fine-grained tokens are not yet supported. For more information, see the `Github Documentation on Personal Access Tokens <https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token>`_.

.. note:: If the repository uses `Git LFS <https://git-lfs.com>`_, its
`"Include Git LFS objects in archives" <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository>`_
setting must be enabled on Github. This descriptor downloads a Release's zip archive rather than
doing a git clone, and Github only includes real Git LFS content in that archive when this setting
is turned on; otherwise the downloaded files will contain unresolved LFS pointer text. This setting
isn't exposed through the Github API and must be checked/enabled manually per repository.


Pointing to a path on disk
==========================
Expand Down
Loading