Skip to content

Latest commit

 

History

History
146 lines (104 loc) · 5.42 KB

README.md

File metadata and controls

146 lines (104 loc) · 5.42 KB

cytanb-vci-lua

Build Status

VCI のスクリプトから利用できる Lua のモジュールです。

cytanb-tso-collab は関連するプロジェクトです。

Softwares / Libraries

Git

  • Git 公式サイト

  • Git に関する詳しい情報は、Web の資料に当たってください。

Pull request の作成手順

  1. GitHub の cytanb-vci-lua リポジトリを Fork します。(プロジェクトサイト右上 Fork ボタン)

  2. フォークしたリポジトリをローカルへ clone します。

  3. 機能開発用のブランチを作成します。

    feature/sample ブランチとして作成する例

    git checkout -b feature/sample

  4. ローカルで変更を行い commit します。

  5. 変更したブランチを push します。

    git push origin feature/sample

  6. GitHub のサイト上でフォークしたリポジトリから Pull request を作成します。

フォーク元のリポジトリに追従する手順

  1. リモートリポジトリを追加します。

    現在の状態を確認します。

    git remote -v

    既に upstream としてフォーク元のリポジトリが追加されている場合は、この手順をスキップして次へ進みます。

    upstream としてリモートジポジトリを追加します。

    git remote add upstream https://github.com/oocytanb/cytanb-vci-lua.git

  2. リモートの master ブランチを merge し、フォーク先のリポジトリに push します。

    git checkout master
git fetch upstream
git merge upstream/master
git push origin master

  3. 作業ブランチをチェックアウトし、merge あるいは rebase して、master ブランチの変更を取り込みます。

    git checkout feature/sample

    • merge して変更を取り込む場合

      git merge master

    • rebase して変更を取り込む場合

      git rebase master

  4. 変更したブランチを push します。

    git push origin feature/sample

Unit testing

  • Travis CI により、リポジトリに Push すると自動テストが行われます。

  • テスティングフレームワークとして、busted を導入しています。

  • ローカル環境でテストを実行するには、LuaRocks とともにインストールします。

  • Lua 環境を構築する方法として、hererocks を利用することができます。

  • Windows 環境では以下の手順になります。

    1. python をインストールします。 depot_tools をインストールしている場合は、python が含まれていますので、それを利用することができます。

    2. コンパイラーとして Visual Studio をインストールします。 (もしくは gcc を利用することも可能です。)

    3. Visual Studio の Command Prompt を開き、以下のコマンドを実行します。ここでは、%LOCALAPPDATA%\luaenv ディレクトリに Lua 環境をインストールしています。

      set LUAENV=%LOCALAPPDATA%\luaenv
python -m pip install hererocks --user
set PATH=%APPDATA%\Python\Scripts;%PATH%
hererocks "%LUAENV%" --lua 5.2 -rlatest
set PATH=%LUAENV%\bin;%PATH%
luarocks install busted
luarocks install dkjson

    4. busted コマンドでテストを実行します。ファイル名に _spec が含まれている lua ファイルがテスト対象となります。

      chcp 65001
busted src

    5. そのほか、luacheck による静的解析を行うこともできます。

      luarocks install luacheck
luacheck src

License

  • ライセンスは、各スクリプト/ライブラリーについて、それぞれご確認ください。

  • アセット等に適用するライセンスは、制作者の著作権表示とその成果物をオープンで自由に利用できることを明示する目的で、主に以下のものから選択しています。

Community

Discord