May 31, 2014

発表のスライド (Changelog on Blog)

チェンジログを題材にRuby製のツールを紹介しました。

• Ruby製のおなじみのGitHubのGitHub Pagesにチェンジログをホスティングします。
  • GitLabもRuby製ですね。
• GitHub PagesnにはRuby製の静的サイトを生成ツールのJekyllが利用できます。
  • Jekyllは2系がリリースされています。
• JekyllではRuby製のテンプレートエンジンのLiquidが使われています。
  • Ruby製のE-commerceのShopifyが開発をしています。

nSumeを使ってデモをしました。

サイトのジェネレート

JekyllでBootswatchのテーマが使えるnSumeを利用します。

gem install nsume
mkdir example
cd example/
nsume init --site project

• 数回のコマンドでChangelogのサイトができます。
  • Vagrantっぽいサブコマンドにしています。

チェンジログの追加

Jekyllは日付とタイトルの単位でファイルが作成されます。

nsume post 0.0.1

• Markdownで記述ができるのでカジュアルなチェンジログにしましょう。
  • Markdownは画像の表示にリンクも追加できます。さらに位置やサイズの調整が可能です。

パブリックに公開

Githubにexampleのリポジトリを作ります。

git init
git checkout -b gh-pages
git add --all
git commit -m "Initial commit"
git remote add origin git@github.com:ogom/example.git
git push -u origin gh-pages

ローカルでも確認

パブリックへの公開に5分もかかりませんが、ローカルでも確認できます。

nsume up

• nsume up --provider=awsでs3で公開する機能も実装できそうです。

チェンジログの書式

特に規定はありませんが、gitのコミットメッセージのルールを統一するとログから生成できます。

git log --date=short --pretty=format:"%ad %an %s (#%h)"

nSumeのおまけ

Railsで実装されたREST APIのドキュメントを生成します。

nSumeのサンプル

• RSpecの結果からドキュメントを作成します。
• ステートマシン ダイアグラムをModelから生成します。
• エンティティ リレーションシップ ダイアグラムをSchemaから生成します。

シーケンス ダイアグラム等はPlantUMLから生成すればよいですね。