README ファイルの使用

ワークフローの手順、図、重要な情報を含む README.md ファイルをアップロードします。各ワークフローバージョンは 1 つの README ファイルをサポートしており、いつでも更新できます。

README の要件は次のとおりです。

• README ファイルはマークダウン (.md) 形式である必要があります

• 最大ファイルサイズ: 500 KiB

既存の README を使用する

Git リポジトリからエクスポートREADMEs には、通常リポジトリの外部では機能しない相対リンクが含まれています。HealthOmics Git 統合は、これらをコンソールで適切にレンダリングするための絶対リンクに自動的に変換するため、手動で URL を更新する必要がなくなります。

Amazon S3 またはローカルドライブからインポートREADMEs の場合、イメージとリンクはパブリック URLs を使用するか、適切なレンダリングのために相対パスを更新する必要があります。

注記

HealthOmics コンソールに表示するには、イメージをパブリックにホストする必要があります。GitHub Enterprise Server または GitLab Self-Managed リポジトリに保存されているイメージはレンダリングできません。

レンダリング条件

HealthOmics コンソールは、絶対パスを使用してパブリックにアクセス可能なイメージとリンクを補間します。プライベートリポジトリから URLsレンダリングするには、ユーザーがリポジトリにアクセスできる必要があります。カスタムドメインを使用する GitHub Enterprise Serverまたは GitLab Self-Managedリポジトリの場合、HealthOmics は相対リンクを解決したり、これらのプライベートリポジトリに保存されているイメージをレンダリングしたりすることはできません。

次の表は、 AWS コンソールの README ビューでサポートされているマークダウン要素を示しています。

要素	AWS コンソール
アラート	はい、ただしアイコンなし
バッジ	あり
基本的なテキストフォーマット	あり
コードブロック	はい。ただし、構文の強調表示とコピーボタンの機能はありません。
折りたたみ可能なセクション	あり
見出し	あり
イメージ形式	あり
イメージ (クリック可能）	あり
改行	あり
Mermaid の図	グラフを開く、グラフの位置を移動する、コードをコピーできるのは のみです
Quotes	あり
サブスクリプトとスーパースクリプト	あり
テーブル	はい。ただし、テキストアラインメントはサポートされていません
テキストの整列	あり

イメージ URL とリンク URLs

ソースプロバイダーに応じて、ページとイメージの基本 URLs を次の形式で構成します。

• {username}: リポジトリがホストされているユーザー名。

• {repo}: リポジトリ名。

• {ref}: ソースリファレンス (ブランチ、タグ、コミット ID)。

• {path}: リポジトリ内のページまたはイメージへのファイルパス。

ソースプロバイダー	ページ URL	イメージ URL
GitHub	https://github.com/{username}/{repo}/blob/{ref}/{path}	https://github.com/{username}/{repo}/blob/{ref}/{path}?raw=true https://raw.githubusercontent.com/{username}/{repo}/{ref}/{path}
GitLab	https://gitlab.com/{username}/{repo}/-/blob/{ref}/{path}	https://gitlab.com/{username}/{repo}/-/raw/{ref}/{path}
Bitbucket	https://bitbucket.org/{username}/{repo}/src/{ref}/{path}	https://bitbucket.org/{username}/{repo}/raw/{ref}/{path}

GitHub、GitLab、および は、パブリックリポジトリにリンクするページ URL とイメージ URLs の両方Bitbucketをサポートします。次の表は、プライベートリポジトリのイメージ URL とリンク URLs のレンダリングに対する各ソースプロバイダーのサポートを示しています。

プライベートリポジトリのサポート
ソースプロバイダー	ページ URL	イメージ URL
GitHub	リポジトリへのアクセスのみ	なし
GitLab	リポジトリへのアクセスのみ	なし
Bitbucket	リポジトリへのアクセスのみ	なし