Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 2.41 KB

README_for_developer.md

File metadata and controls

48 lines (35 loc) · 2.41 KB
Raw

Usage for Developer

開発者用のドキュメントです。 ソースコードの生成、テスト実行、リリース手順などを記載します。

開発方法

VSCodeのdevcotainerを利用して開発します。 https://code.visualstudio.com/docs/remote/containers

  1. 以下の環境変数を定義する
    • ANNOFAB_USER_ID : AnnofabのユーザID
    • ANNOFAB_PASSWORD : Annofabのパスワード
    • DATA_DIR : devcontainer外のファイルにアクセスしたい場合、そのファイルの存在するディレクトリを指定してください。devcontainerでは/dataでアクセスできます。この環境変数はdevcontainer.jsonでしか参照されていません。

      annofab-cli/.devcontainer/devcontainer.json

      Line 20 in 62c6bb4

      "source=${localEnv:DATA_DIR},target=/data,type=bind",

Test

テストの実行方法

  1. Annofabの認証情報を、.netrcファイルまたは環境変数に設定する。
  2. 以下のコマンドを実行して、テスト用のプロジェクトとタスクを作成する。
$ git clone https://github.com/kurusugawa-computer/annofab-api-python-client.git
$ poetry run python annofab-api-python-client/tests/create_test_project.py --organization ${MY_ORGANIZATION}
  1. pytest.iniに、テスト対象のプロジェクトとタスクを指定するを指定する。
    • task_idはプロジェクトproject_id配下であること
  2. $ make testコマンドを実行する。
    • 【注意】テストを実行すると、Annofabプロジェクトの内容が変更されます

Versioning

annofabcliのバージョンはSemantic Versioning 2.0に従います。

annofabcliのバージョンは以下のファイルで定義しています。

  • annofabcli/__version__.py
  • pyproject.toml

Release

GitHubのReleasesからリリースしてください。 バージョンはSemantic Versioningに従います。 リリースすると、以下の状態になります。

開発フロー

  • mainブランチを元にしてブランチを作成して、プルリクを作成してください。mainブランチへの直接pushすることはGitHub上で禁止しています。