Oracle Cloud Infrastructureドキュメント

「Open in Code Editor」ボタンの使用

「コード・エディタで開く」ボタンの使用方法について学習します。

一部のGitリポジトリまたはWebサイトには、「コード・エディタで開く」ボタンがあります。このボタンをクリックすると、クラウド・シェル・セッションでリポジトリが自動的にクローニングされ、コード・エディタで開きます。

「Open in Code Editor」ボタンを使用するには:
  1. 「コード・エディタで開く」ボタンをクリックします。
  2. プロンプトが表示されたら、OCIコンソールにログインします。
  3. コード・エディタ・セッションが開始され、「クローニングの検証」ダイアログが表示され、リポジトリをクローニングすることを確認できます。

    「ワンクリック・クローン検証」ダイアログ・ボックス
    1. 宛先ディレクトリのデフォルトはリポジトリ名です。これを変更するには、「ディレクトリ名の入力」テキスト・ボックスに新しい値を入力します。
    2. Oracle使用条件の確認および受諾を行ったことを示すチェック・ボックスを選択します。
    3. 「クローン」ボタンをクリックします。

コード・エディタは、リポジトリを宛先ディレクトリにクローニングし、エディタ内でプロジェクトのREADMEファイルを開きます。

たとえば:ワンクリッククローンREADMEのスクリーンショット

「Open in Code Editor」ボタンの埋込み

「コード・エディタで開く」ボタンを自分のREADMEファイルに追加できます。
ノート

このリンクの推奨場所は、GitリポジトリのルートREADME.mdファイルです。

独自のコンテンツに「コード・エディタで開く」ボタンを追加するには、URLに次のパラメータを指定する必要があります。

パラメータ
URLパラメータ 説明
cs_repo_url [必須]アクセス可能なGitリポジトリURL。
cs_branch [オプション]チェックアウトするブランチ。指定しない場合、デフォルトのブランチが使用されます。
cs_open_ce [オプション]必要なスクリプトをクローニングして実行した後、コード・エディタを開きます。コード・エディタは、クローニングされたフォルダをワークスペースに自動的に開きます。
cs_initscript_path [オプション]実行可能スクリプトへのパス。ファイル・パスは、現在のディレクトリを基準とする相対パスです。
cs_readme_path [オプション] gitリポジトリ内のreadmeファイルへのパス。このファイルの内容は、リポジトリのクローニング後にクラウド・シェルまたはコード・エディタに表示されます。これには、ようこそメッセージおよびユーザーへの詳細な指示が含まれる場合があります。ファイル・パスは、現在のディレクトリを基準とする相対パスです。
この例は、GitリポジトリのREADME.mdファイルに「コード・エディタで開く」ボタンを埋め込むURLを示しています。ボタンをクリックすると、Oracle Cloudドメインにリダイレクトされ、次に示すように、必要なすべての問合せパラメータが渡されます。 
[![Open in Code Editor](https://raw.githubusercontent.com/oracle-devrel/oci-code-editor-samples/main/images/open-in-code-editor.png)](https://cloud.oracle.com/?region=home&cs_repo_url=https://path-to-repo/sample.git&cs_branch=branch-name/to/checkout&cs_readme_path=relative-path/to/readme-file&cs_initscript_path=relative-path/to/script&cs_open_ce=true/false)
ノート

SSH URLではなくHTTP URLを使用することをお薦めします。セキュリティのため、リダイレクトされたURL問合せパラメータにcs_initscript_pathがある場合でも、信頼できないGitHubリポジトリからの自動スクリプト実行は無効になります。