在 GitHub 上显示二进制文件的文本差异

Question

我正在尝试使用 Git 和 GitHub 来同步一些应用配置文件。这些是以二进制格式存储的 XML 或 plist 文件。例如，Keyboard Maestro .kmsync file。

我可以open these files via a text editor查看 XML 格式。

但是当我在 GitHub 拉取请求、提交视图等中查看这些文件差异时，我看到了一个无用的二进制差异，没有可见的更改：

显示有 0 个添加和 0 个删除。
BIN +17 字节 (100%)
二进制文件未显示。

我可以通过 git 通过 .gitattributes 文件在本地显示基于文本的差异。但是，GitHub 似乎不尊重这些修改：

GitHub 不使用 .gitattributes 文件来选择要在 diff 中显示的文件，因此无法通过这种方式解决此问题。 [source]

当我在 GitHub 上的提交和拉取请求中查看这些文件时，我想查看基于文本的更改和行差异。

例如这里的 GitHub PR。随意分叉和实验：
https://github.com/pkamb/so/pull/1

如何说服 GitHub 存储库 的 Web 视图对某些“二进制”文件使用基于文本的差异？

---

我找不到针对我的特定问题的现有问题（在 GitHub 上显示非二进制差异 ）。

以下问题与此相同行为有关，但针对本地 git（不是 GitHub）。

• Override git's choice of binary file to text
• How would you put an AppleScript script under version control?

我的问题是这个问题的相反，它试图在 GitHub 上将文本文件显示为二进制文件：

• Make github use .gitattributes "binary" attribute

Answer 1

没有办法强制 GitHub 将这些文件显示为文本，因为它们不是。当 GitHub 将文件呈现为 HTML 页面的一部分时，它们必须采用某种编码，而如今唯一合理的编码选择是 UTF-8。这些文件无法按原样显示为 UTF-8，因为它们包含在 UTF-8 中无效的字节序列，以及控制字符，这些字符通常无法在网页中很好地呈现。

可以使用配置文件中的diff 类型和diff.*.textconv 属性将这些文件转换为文本以使用.gitattributes 文件进行比较。这在你的机器上很好用，但在 GitHub 上不行。首先，GitHub 没有你渲染文件的工具，其次，GitHub 一般不支持外部程序渲染文件，主要是出于安全原因。支持一些常见格式，但这不是其中之一。

还要注意，要使用的程序存储在Git配置中，而不是.gitattributes文件中；这是故意的，因为在存储库中提供要执行的程序列表是一个安全问题。因此，GitHub 甚至不可能知道你在这里使用的程序。

如果您的kmsync 文件具有可以编译成二进制格式的纯文本等价物，那么您可以将该格式存储在存储库中，并将其作为构建步骤的一部分进行构建。这将是可区分的，并且仍将提供可用于项目的二进制格式。这与将代码编译成二进制文件或将纯文本编译成 PDF 没有什么不同。