ツイートシェアはてブ LINE Pocket

開発ファイル

プロジェクトの開発環境を構成するには、devfile を使用する必要があります。開発ファイル(英語)は、ビルド環境の構成と実行に YAML 形式を使用するオープン仕様です。Space は、2.2.0 仕様の機能サブセットのみをサポートします (サポートされる機能は、現在の Space ドキュメントで完全にカバーされています。このドキュメントに機能が記載されていない場合、その機能はサポートされていません)。

開発ファイルの場所

my-project // project root
├─── .space
│   ├─── frontend.devfile.yaml  // user devfile
│   ├─── backend.devfile.yaml   // user devfile
│   └─── ...                    // *.devfile.yaml files
│
...

プロジェクトには、リポジトリルートの .space ディレクトリに 1 つの devfile.yaml ファイルまたは複数の *.devfile.yaml ファイルが存在する場合があります。

ユーザーが開発環境を作成するとき、プロジェクト内で利用可能なすべての開発ファイルから選択できます。開発環境設定は、選択した devfile から取得されます。

devfile を作成する

プロジェクトの .space ディレクトリに devfile を手動で作成する必要があります。Space UI で devfile を作成または編集する場合は、組み込みの devfile スニペットを使用できます。

自動生成された devfile

プロジェクト所有者は、プロジェクトの devfile の自動生成を有効にすることができます。新しい開発環境を作成するときにユーザーが特定の devfile を指定しない場合、Space は作成ダイアログで指定された設定に基づいて devfile を自動的に生成します。生成された devfile は .space/generated.devfile.yaml に保存されます (ファイルがすでに存在する場合は書き換えられます)。開発環境が作成された後、ユーザーはこのファイルをプロジェクトリポジトリにコミットしてプッシュできます。

devfile の自動生成を有効にするには

プロジェクトを開きます。
サイドバーで、開発環境を選択します。
設定をクリックし、既存のファイルが指定されていない場合、起動時に devfile を自動生成しますを選択します。

開発ファイルの例

schemaVersion: 2.2.0
metadata:
  name: 'My custom dev env configuration'
attributes:
  space:
    # regular, large, xlarge
    instanceType: large
    # a default IDE for the project
    editor:
      # (Required) IDE type: Idea, WebStorm, PyCharm,
      # RubyMine, CLion, Fleet, GoLand, PhpStorm
      type: Idea
      version: '2022.1'
      # Space uses JetBrains Toolbox App to install IDEs to a dev environment.
      # updateChannel defines IDE version release stage: Release, EAP
      updateChannel: EAP
      # JVM configuration (appends to the default .vmoptions file)
      vmoptions:
      - '-Xms2048m'
      - '-Xmx4096m'
    # a warm-up snapshot
    warmup:
      # create a snapshot every Sunday (only for main branch)
      startOn:
      - type: schedule
        cron: '0 0 0 ? * SUN *'
      # run additional warmup script (IDE indexes will be built anyway)
      script:
        ./scripts/warmup.sh
    # Parameters and secretes required by a dev environment
    # e.g., credentials to an external service
    requiredParameters:
    # (Required) the name of the environment variable
    # that will be available in the dev environment
    - name: USERNAME
      description: 'Space username'
    requiredSecrets:
    - name: PASSWORD
      description: 'Space permanent token'
components:
- name: dev-container
  # Dev environment container config
  container:
    # use image from a Space Packages registry
    image: mycompany.registry.jetbrains.space/p/myprj/container/my-dev-image:27
    # environment variables
    env:
      - name: API_URL
        value: 'https://my-site/http_api'
      - name: PATH_IMG
        value: './img/'

最終更新日: 2024 年 3 月 04 日

関連ページ：

開発環境で開発する

前提条件：開発環境で開発を開始する前に、次の手順を実行します。JetBrains Toolbox アプリをローカルマシンにインストールします。IntelliJ ベースの IDE を使用する場合は、Toolbox アプリを利用して JetBrains Gateway をインストールします。(オプション) プロジェクトの開発環境を構成します。この手順をスキップすると、プロジェクトはデフォルトの Docker イメージに基づいて開発環境で開かれます。開発環境で開きたいプロジェクトに少なくともプロジェク...

プロジェクトに参加する

あるプロジェクトに貢献を開始したい場合は、そのプロジェクトに参加する必要があります。つまり、そのプロジェクトのメンバーになる必要があります。貢献しようとしているプロジェクトに移動します。すでにメンバーである場合は、プロジェクトのページのプロジェクトメンバーにリストされます。そうでない場合は、プロジェクト管理者に連絡してメンバーシップを依頼してください。プロジェクト管理者を確認するには、プロジェクトページでメンバーウィジェットをクリックします。プロジェクトを探す：すべてのプロジェクトは名前で見つ

開発環境の構成

可能な限り最高のエクスペリエンスを提供するには、プロジェクト用に開発環境を事前に構成する必要があります。構成された環境には、必要なすべてのツールとランタイム、IDE インデックス、プロジェクトに必要なその他のデータ (環境変数、プロジェクトの依存関係など) が含まれます。その結果、ユーザーは開発環境の作成後すぐにプロジェクトの作業を開始できます。開発環境の構成は、devfiles を使用して定義されます。これは、プロジェクトのディレクトリにある 1 つのまたは一連のファイルです。devfile...

構成名

複数の devfile を含むプロジェクト内の特定の開発環境構成をユーザーが区別できるようにするには、各構成の名前を指定します。名前を指定しない場合、構成には、使用する IDE にちなんで名前が付けられます。名前を指定するには、パラメーターを使用します。schemaVersion: 2.2.0 metadata: name: 'My custom config' attributes: space: editor: type: Idea ユーザーは、新しく作成された開発環境の devfile を選...