Skip to content

github-release-checklist.md

Latest commit

 

History

History
52 lines (41 loc) · 2.88 KB

github-release-checklist.md

File metadata and controls

52 lines (41 loc) · 2.88 KB
Raw

GitHub Release Checklist

이 문서는 oslab을 처음 GitHub에 공개하기 전에 확인할 항목입니다.

Public Positioning

  • README.md는 private product 중심이 아니라 generic OS/VM integration test platform 중심으로 설명한다.
  • docs/oslab-platform-plan.md는 public generic platform plan으로 정리한다.
  • 첫 실행 예시는 generic demo suite를 사용한다.
  • Product-specific 관련 내용은 product-owned/private docs로 분리한다.
  • 기존 product-specific 중심 platform plan은 private/product-owned docs에 보관한다.
  • 로컬 lab run id, 실제 Proxmox IP, 실제 node 이름은 공개 문서에 남기지 않는다.

Onboarding

  • 초기 설치 명령을 제공한다.
  • config/oslab.local.example.yaml과 config/oslab.local.example.env 복사 흐름을 설명한다.
  • Proxmox API token 생성 위치와 token id 형식을 설명한다.
  • Proxmox token은 lab demo 기준이며 production/shared cluster 전 least-privilege 검토가 필요하다고 명시한다.
  • staged preflight 흐름을 제공한다.
  • PowerShell/Python/C demo 실행 명령과 demo catalog를 제공한다.
  • runs/<run-id>/ 결과 확인 방법을 설명한다.
  • JUnit/JSON/HTML report의 용도를 설명한다.
  • Stale VM/VMID range 수동 복구 runbook을 제공한다.
  • CI에서 실패 시에도 runs/** artifact를 보존하는 pattern을 설명한다.

Repository Hygiene

  • config/oslab.local.yaml과 config/oslab.local.env는 ignore 대상이다.
  • runs/는 ignore 대상이다.
  • Demo artifact files under validation/artifacts/ are not ignored.
  • Example env files do not contain real secrets.
  • 개발/브라우저/authoring smoke 중 생성되는 timestamp 더미 산출물은 ignore 대상이다.
  • 공개 repo에 포함하면 안 되는 product-specific overlay는 private/, *.local.*, *.private.yaml 계열로 분리한다.
  • config/public-release-blocklist.local.txt에 사내용 product marker와 private domain marker를 추가한다.
  • scripts/check-public-release.ps1 -IncludeUntracked로 tracked/untracked 공개 차단 marker와 더미 산출물을 확인한다.
  • 최종 commit 전에 secret scan을 한 번 더 실행한다.

Validation

  • Demo scenario schema validation passes.
  • Local unit test suite passes.
  • Public release audit script passes with the local private marker blocklist.
  • GitHub Actions workflow를 추가한다.
  • README에 CI badge를 추가한다.

Known Limits For First Release

  • Windows/Proxmox/QEMU Guest Agent path is the implemented path.
  • Linux support is documented as a target, but not the first complete implementation path.
  • WinRM/SSH credentials in config are reserved for future guest channels.
  • Proxmox least-privilege role guidance should be tightened before production cluster use.