README

Gitify的目标是提供MODX数据库中通常存储的数据的双向同步，使其可以通过Git进行版本控制。为此，它创建了一个MODX对象的文件表示。这些文件遵循一种对人和机器都友好的格式，由YAML块组成，后跟一个分隔符，然后是主内容（如果有特定的内容字段）。

项目配置文件，它决定了哪些数据被写入文件并构建到数据库中，存储在项目根目录下的.gitify文件中。

升级到v2

Gitify v2带来了更新的依赖项，额外的功能，以及通过Composer更容易的安装/更新。

数据文件结构没有变化，因此您可以安全地升级到v2。

如果您希望为Gitify做出贡献，可以将现有的git安装保留。
1. 将分支更新到最新状态（使用git fetch origin && git reset --hard origin/master或git fetch upstream && git reset --hard upstream/master）
2. 安装更新后的依赖项（使用composer install）
3. 更新您的$PATH以指向bin目录。这可能在您的~/.bash_profile或~/.zshrc文件中。
如果要简单地使用Gitify，建议完全删除v1基于git的安装，并按照下面安装部分中描述的，使用Composer全局安装Gitify。

重要提示

composer global require modmore/gitify:^2

如果这没有使gitify可在您的路径上使用，请将composer global config bin-dir --absolute的输出添加到您的路径中（例如，在Mac/Linux上的~/.bash_profile或~/.zshrc文件中）。

要更新，请使用composer global update modmore/gitify。

或者，您可以使用composer require modmore/gitify:^2将Gitify本地安装到项目中。在这种情况下，您需要使用vendor/bin/gitify作为命令。

当安装alpha/dev版本时，如果您之前未修改全局composer配置，您可能会收到有关您的minimum-stability设置的错误消息。（Composer默认为稳定版，而我们想要一个不稳定版本！）要修复此问题，您需要使用以下命令设置全局最低稳定性

composer global config minimum-stability alpha

使用手动安装从源代码构建，如果您打算帮助使Gitify变得更好，这很有用。

$ git clone https://github.com/modmore/Gitify.git Gitify
$ cd Gitify
$ composer install --no-dev
$ chmod +x bin/gitify

请参阅安装文档以获取更多详细信息。

查看modmore Gitify文档！它包含有关可用命令以及如何设置合适工作流程的信息。

请随时通过编辑现有页面或添加包含尚未在其他地方涵盖的额外信息的页面来为wiki做出贡献。

Gitify遵循semver。由于我们现在在v1之前，在API稳定之前，预计会有破坏性更改和重构。

有关更改，请参阅提交日志或变更日志。

MIT许可证（MIT）

在此特此授予任何人免费获得此软件及其相关文档副本（以下简称“软件”）的权利，不受限制地处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件的副本，并允许向软件提供者提供软件的人这样做，前提是遵守以下条件