帮酷LOGO
  • 显示原文与译文双语对照的内容
文章标签:Commit  COM  COMM  GIT  Git Commit  变更记录  历史  bea  
Generate beautiful changelogs from your Git commit history

  • 源代码名称:clog-cli
  • 源代码网址:http://www.github.com/clog-tool/clog-cli
  • clog-cli源代码文档
  • clog-cli源代码下载
  • Git URL:
    git://www.github.com/clog-tool/clog-cli.git
  • Git Clone代码到本地:
    git clone http://www.github.com/clog-tool/clog-cli
  • Subversion代码到本地:
    $ svn co --depth empty http://www.github.com/clog-tool/clog-cli
    Checked out revision 1.
    $ cd repo
    $ svn up trunk
  • 堵塞

    Join the chat at https://gitter.im/thoughtram/clog

    Build Status

    我们的常规变更日志

    clog 会自动从本地git元数据创建变更日志。 参见 clogchangelog.md 插件以获得示例。

    这种方式,就是每次提交的时候,确保提交主题行遵循常规格式的格式。 然后,当你希望更新自己的更新日志时,只需在本地存储库中运行 clog 即可以指定。

    注意:clog 还通过提交诸如 alias: message 或者 alias(): message 之类的提交消息来支持空组件。 没有组件)

    用法

    使用 clog 有两种方法,即通过 命令行 或者在应用程序中作为一个库,通过阻塞 lib

    二进制( 命令行 )

    为了通过 命令行 使用 clog,必须首先编译二进制文件,或者者通过downlading和安装预编译二进制文件。

    cargo install

    如果你希望使用cargo编译和安装 clog,只需运行

    cargo install clog-cli
    编译

    按照以下说明编译 clog,然后跳到安装。

    • 确保你有当前版本的cargoRust 插件
    • 克隆项目 $ git clone https://github.com/clog-tool/clog-cli && cd clog-cli
    • 生成项目 $ cargo build --release
    • 完成后,二进制文件将位于 target/release/clog
    • 使用预编译二进制文件

    目前没有可用的预编译二进制文件。

    英镑笔记:Mac分布在npm上通过阻塞 cli

    安装

    下载或者编译后,clog 只需要将二进制文件放在 $PATH 中。 如果你不熟悉 $PATH 阅读,否则跳到使用阻塞。

    Arch Linux

    你可以从AUR使用 clog-bin,或者按照 linux/OS X的说明进行操作

    linux/OS X

    你有两个选项,将 clog 放入 $PATH 变量( 。要查看那些目录,请打开终端并键入 echo"${PATH//:/n}",引号是重要的) 中已经存在的目录,或者你可以将定制目录添加到你的$PATH 中。

    如果你对 $PATH 中列出的目录有写权限,或者你拥有 root 权限( 或者通过 sudo ),只需将该目录复制到该目录,则 Option# sudo cp clog/usr/local/bin

    如果你在目录中没有 root,sudo 或者写权限,则可以使用英镑选项 2,你可以在主目录中创建目录,并添加该目录。 许多人使用 $HOME/.bin 来保持隐藏的( 而且不会弄乱你的主目录),如果你希望它永远可以见,则使用 $HOME/bin 。 下面是创建目录。将它的添加到 $PATH 并在其中复制 clog的示例。

    只需将 bin 更改为你想要 NAME的目录,.bashrc 到任何 shell 启动文件( 通常是 .bashrc.bash_profile 或者 .zshrc )

    $ mkdir ~/bin
    $ echo"export PATH=$PATH:$HOME/bin">>~/.bashrc
    $ cp clog ~/bin
    $ source~/.bashrc
    Windows

    在 Windows 7/8 中,可以以通过管理员打开 命令行 并运行,将目录添加到 PATH 变量。

    C:> setx path "%path%;C:pathtoclogbinary"

    否则,请确保你在 命令行 中的目录中有 clog 二进制文件,因为 Windows 自动将当前目录添加到路径( 例如 ) 。 如果打开 命令行 到 C:my_project 以使用 clog,请确保 clog.exe 也在该目录中。

    从 命令行 中 clog

    clog 通过读取 git 元数据和专门制作的提交消息和主题来创建变更日志。 clog 有以下选项:availble 。

    USAGE:
     clog [FLAGS] [OPTIONS]
    FLAGS:
     -F, --from-latest-tag use latest tag as start (instead of --from)
     -h, --help Prints help information
     -M, --major Increment major version by one (Sets minor and patch to 0)
     -m, --minor Increment minor version by one (Sets patch to 0)
     -p, --patch Increment patch version by one
     -V, --version Prints version information
    OPTIONS:
     -C, --changelog <changelog> A previous changelog to prepend new changes to (this is like
     using the same file for both --infile and --outfile and
     should not be used in conjuction with either)
     -c, --config <config> The Clog Configuration TOML file to use (Defaults to
     '.clog.toml')** -T, --format <format> The output format, defaults to markdown
     (valid values: markdown, json)
     -f, --from <from> e.g. 12a8546
     -g, --git-dir <gitdir> Local. git directory (defaults to current dir + '.git')* -i, --infile <infile> A changelog to append to, but *NOT* write to (Useful in conjunction with --outfile)
     -o, --outfile <outfile> Where to write the changelog (Defaults to stdout when omitted)
     -r, --repository <repo> Repository used for generating commit and issue links
     (without the. git, e.g. https://github.com/clog-tool/clog-cli)
     -l, --link-style <style> The style of repository link to generate
     (Defaults to github) [values: Github Gitlab Stash]
     -s, --subtitle <subtitle> e.g. "Crazy Release Title" -t, --to <to> e.g. 8057684 (Defaults to HEAD when omitted)
     --setversion <ver> e.g. 1.0.1
     -w, --work-tree <workdir> Local working tree of the git project
     (defaults to current dir)** If your. git directory is a child of your project directory (most common, such as
    /myproject/.git) AND not in the current working directory (i.e you need to use --work-tree or
    --git-dir) you only need to specify either the --work-tree (i.e./myproject) OR --git-dir (i.e.
    /myproject/.git), you don't need to use both.** If using the --config to specify a clog configuration TOML file NOT in the current workingdirectory (meaning you need to use --work-tree or --git-dir) AND the TOML file is inside yourproject directory (i.e./myproject/.clog.toml) you do not need to use --work-tree or --git-dir.
    试试 !

    为了在行动中看到它,你将需要一个存储库,它的中已经经有一些特殊的提交消息。 为此,我们将使用 clog 存储库本身。

    克隆 repo git clone https://github.com/clog-tool/clog-cli && cd clog-cli

    确保已经从上任一步骤中删除了 clog

    有很多种运行 clog的方法。 在这些例子中,我们会反复输入相同的选项,有时候我们会像阻塞TOML配置文件来指定那些通常不会改变的选项。 还要注意,所有这些CLI选项都有短版本,我们使用长版本,因为它们更容易理解。

    我们从上次发布之后只选择新的提交( 这可以能不是很多。"。"。或者者没有)

    运行 clog -r https://github.com/clog-tool/clog-cli --outfile only_new.md

    如果在TOML配置文件中设置了文件集,默认情况下,clog 将输出到 stdout 。 ( 注意,我们可以使用 shell > 操作符而不是 --outfile )

    通过CLI设置的任何选项都将覆盖你设置配置文件的任何。

    现在让我们告诉 clog 在哪里可以以找到旧的更新日志,并将任何新的提交放到

    运行 clog -r https://github.com/clog-tool/clog-cli --infile changelog.md --outfile new_combined.md

    最后,我们假设大多数项目只需要使用一个文件,并将所有新数据预先设置为旧的更新。

    首先备份 changelog.md,以便以后对它的进行比较

    运行 clog -r https://github.com/clog-tool/clog-cli --changelog changelog.md

    尝试查看你最喜爱的Markdown 查看器中的任何 only_new.mdnew_combined.mdchangelog.md.bak 或者 changelog.md,以进行比较。

    有关在应用程序中使用的信息,请参阅文档或者阻塞。 你也可以看到堵塞 crates.io 页面。

    默认选项

    也可以使用默认配置文件配置 clog,这样你就不必在每次更新更新日志时都指定所有选项。 为此,在存储库中添加一个 .clog.toml 文件。

    [clog]# A repository link with the trailing '.git' which will be used to generate# all commit and issue linksrepository = "https://github.com/clog-tool/clog-cli"# A constant release titlesubtitle = "my awesome title"# specify the style of commit links to generate, defaults to"github" if omittedlink-style = "github"# The preferred way to set a constant changelog. This file will be read for old changelog# data, then prepended to for new changelog data. It's the equivilant to setting# both infile and outfile to the same file.## Do not use with outfile or infile fields!## Defaults to stdout when omittedchangelog = "mychangelog.md"# This sets an output file only! If it exists already, new changelog data will be# prepended, if not it will be created.## This is useful in conjunction with the infile field if you have a separate file# that you would like to append after newly created clog data## Defaults to stdout when omittedoutfile = "MyChangelog.md"# This sets the input file old! Any data inside this file will be appended to any# new data that clog picks up## This is useful in conjunction with the outfile field where you may wish to read# from one file and append that data to the clog output in anotherinfile = "My_old_changelog.md"# This sets the output format. There are two options"json" or"markdown" and# defaults to"markdown" when omittedoutput-format = "json"# If you use tags, you can set the following if you wish to only pick# up changes since your latest tagfrom-latest-tag = true

    现在你可以使用 clog --patch ( 假设你想从最新的标签版本更新,并增加你的补丁版本 1 ) 更新你的MyChangelog.md

    注意:你在 命令行 上指定的任何选项都将覆盖你在你的.clog.toml 中设置的选项

    自定义节

    默认情况下,clog 将在你的变更日志。FeaturesPerformanceBug Fixes 中显示三个部分。 你可以使用 .clog.toml 文件添加其他节。 要添加多个部分,只需添加一个 [sections] 表,以及你希望在提交消息中使用的节 NAME 和别名:

    [sections]MySection = ["mysec", "ms"]

    现在如果你制作了一条提交消息,如 mysec(Component): some message 或者 ms(Component): some message,那么在"功能"和"Bug 修复"区域上会有一个新的"mysection"部分。

    注意:带空格的节是 suppported,比如 "My Special Section" = ["ms","mysec"]

    辅助项目

    • Commitizen - 一个帮助你编写更好的提交消息的命令行 工具。

    许可证

    clog 是在MIT开放源代码许可下许可的。 有关详细信息,请参阅这里知识库中的许可证文件。



    文章标签:COM  COMM  GIT  bea  历史  Commit  Git Commit  变更记录  

    Copyright © 2011 HelpLib All rights reserved.    知识分享协议 京ICP备05059198号-3  |  如果智培  |  酷兔英语