README 파일 작업

워크플로에 대한 지침, 다이어그램 및 필수 정보가 포함된 README.md 파일을 업로드합니다. 각 워크플로 버전은 언제든지 업데이트할 수 있는 README 파일 하나를 지원합니다.

README 요구 사항은 다음과 같습니다.

• README 파일은 마크다운(.md) 형식이어야 합니다.

• 최대 파일 크기: 500KiB

기존 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 뷰에서 지원하는 마크다운 요소가 나와 있습니다.

Element	AWS 콘솔
알림	예, 하지만 아이콘은 없습니다.
배지	예
기본 텍스트 형식 지정	예
코드 블록	예, 하지만 구문 강조 표시 및 복사 버튼 기능이 없습니다.
축소 가능한 섹션	예
제목	예
이미지 형식	예
이미지(클릭 가능)	예
줄 바꿈	예
Mermaid 다이어그램	만 그래프를 열고, 그래프 위치를 이동하고, 코드를 복사할 수 있습니다.
견적	예
Subscript 및 Superscript	예
테이블	예, 하지만 텍스트 정렬을 지원하지 않습니다.
텍스트 정렬	예

이미지 및 링크 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및는 퍼블릭 리포지토리에 연결되는 페이지 및 이미지 URLs을 모두 Bitbucket 지원합니다. 다음 표에는 프라이빗 리포지토리에 대한 이미지 및 링크 URLs 렌더링에 대한 각 소스 공급자의 지원이 나와 있습니다.

프라이빗 리포지토리 지원
소스 공급자	페이지 URL	이미지 URL
GitHub	리포지토리에 액세스할 수 있는 경우에만	아니요
GitLab	리포지토리에 액세스할 수 있는 경우에만	아니요
Bitbucket	리포지토리에 액세스할 수 있는 경우에만	아니요