Home

Welcome to the necstdb wiki!

GitHub Actionsについて

• test

  このリポジトリではmasterブランチまたはバージョン名(e.g. v0.0.0)を含むブランチに行ったコミットをgit pushするとコードテストが走ります。 テストでは実際にデータベースを作り、それを読み込むことで予想される出力が得られているか確認を行っています。 テストが失敗してもpull requestのマージやアップデートなどGit/GitHubの全ての機能を使うことができますが、他バージョンとの互換性を確保するため、できる限りテストが通るように実装を見直してください。

  プログラムの挙動を変更する場合にはtestsフォルダに置いてあるコードから該当部分を探して変更し、予想される挙動をしているか確認できるようにしてください。 予想される挙動はEXPECTED_**という変数名で定義しており、実際に得られた出力はactualという変数に代入しています。 また、新たに機能を追加する場合にはできるだけテスト関数を追加し、実際の挙動を確認できるようにしてください。

• pypi

  リポジトリのトップページにあるReleases > Draft a new releaseからリリースを作成すると自動的にPyPIにアップデートされたバージョンが公開されます。 PyPIにアップロードすることでpipコマンドを使ってパッケージをインストールすることができるようになります。 リリースの名前(Release title)はv0.2.5のようにバージョンを反映したものにしてください。