ghp-rs

轻松将文件夹导入您的 gh-pages 分支！

为什么？

我编写了这个工具来帮助那些想在 gh-pages 分支上托管文档或其他内容的人。这个工具受到了 ghp-import 的很大影响，并且具有类似的实现。

文档

文档可以在 这里 找到。文档由 cargo doc 和 ghp-rs 驱动。查看 .travis.yml 和 travis 配置，了解如何使用 ghp-rs 与 rustdoc。

安装

通过 Cargo

cargo install ghp

通过二进制文件

即将推出！

通过 Git

git clone https://github.com/LucioFranco/ghp-rs
cargo build --release
export PATH="$PATH:/path/to/ghp-rs/target/release/"

命令行使用

ghp [OPTIONS] DIRECTORY

# Example

ghp build # move content of build folder to gh-pages branch

ghp --branch website build # will move the contents of the build folder to the website branch

ghp --message "This is a git commit message" build

程序性使用

Cargo.toml

[dependencies]
ghp = "0.1"

extern crate ghp;
use ghp::import_dir;

import_dir("build", "gh-pages", "commit message").unwrap();

Travis 配置

为此，您需要有一个包含您的 GitHub 个人令牌的 GH_TOKEN 变量。更多信息请参阅 这里。

after_success: |
  [ $TRAVIS_RUST_VERSION = stable ] &&
  [ $TRAVIS_BRANCH = master ] &&
  [ $TRAVIS_PULL_REQUEST = false ] &&  
  ghp target/doc &&
  git config user.name "Travis Documentation" &&
  git config user.email "[email protected]" &&
  git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages

许可

根据以下任一许可授权：

• Apache 许可证 2.0 (LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)，任选其一。

贡献

除非您明确声明，否则您有意提交给作品以包含在内的任何贡献，根据 Apache-2.0 许可证的定义，应双授权如上，无需任何附加条款或条件。