From 372a4e99e35a7848a2017a7eb074a50a0d9e4b27 Mon Sep 17 00:00:00 2001 From: krsjenmt <252349396+krsjenmt@users.noreply.github.com> Date: Sun, 15 Feb 2026 22:19:56 +0700 Subject: [PATCH] docs: add Vietnamese beginner architecture guide --- BEGINNER_GUIDE.vi.md | 60 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 5 ++++ 2 files changed, 65 insertions(+) create mode 100644 BEGINNER_GUIDE.vi.md diff --git a/BEGINNER_GUIDE.vi.md b/BEGINNER_GUIDE.vi.md new file mode 100644 index 00000000..c58a91dc --- /dev/null +++ b/BEGINNER_GUIDE.vi.md @@ -0,0 +1,60 @@ +# Hướng dẫn nhanh cho người mới: `changesets/action` + +## 1) Repo này làm gì? + +Đây là mã nguồn của GitHub Action `changesets/action`. Action này tự động hóa 2 luồng chính: + +- **Version PR**: tạo/cập nhật pull request chứa thay đổi version + changelog từ Changesets. +- **Publish**: khi không còn changeset cần xử lý, chạy lệnh publish và xuất output các package đã phát hành. + +Điểm vào runtime là `src/index.ts`: đọc input từ workflow, quyết định đi nhánh `runVersion` hay `runPublish`, và set outputs cho step của GitHub Actions. + +## 2) Cấu trúc thư mục quan trọng + +- `src/index.ts`: điều phối toàn bộ luồng của action. +- `src/run.ts`: nghiệp vụ chính cho **version** (tạo PR) và **publish** (đọc output publish, tạo GitHub release). +- `src/git.ts`: lớp `Git` trừu tượng thao tác git, hỗ trợ 2 chế độ commit (`git-cli` và `github-api`). +- `src/utils.ts`: hàm tiện ích như đọc changelog entry, xác định package đổi version, sort hiển thị PR body. +- `src/readChangesetState.ts`: đọc trạng thái changeset và xử lý `pre mode`. +- `src/*.test.ts` + `src/__snapshots__`: test chính bằng Vitest. +- `action.yml`: định nghĩa input/output cho GitHub Action. + +## 3) Luồng chạy tổng quát (mental model) + +1. Action lấy token + input (`publish`, `version`, `commitMode`, `cwd`, ...). +2. Đọc danh sách changeset hiện có. +3. Rẽ nhánh: + - **Có changeset**: chạy luồng version (`runVersion`) → commit/push vào nhánh release → tạo hoặc cập nhật PR. + - **Không có changeset nhưng có `publish` script**: chạy luồng publish (`runPublish`) → parse kết quả publish → set output `published`/`publishedPackages`. + - **Không có cả changeset lẫn publish script**: kết thúc sớm. +4. Set outputs để workflow phía trên dùng tiếp. + +## 4) Những điểm quan trọng cần nắm + +- **`commitMode` ảnh hưởng cách ghi commit**: + - `git-cli`: dùng git local (`git add/commit/push`). + - `github-api`: dùng API (`@changesets/ghcommit`) để commit đã ký GPG theo token owner. +- **Giới hạn độ dài PR body**: có cơ chế cắt bớt nội dung changelog để tránh vượt limit payload GitHub. +- **`pre mode` của Changesets**: được phát hiện và hiển thị cảnh báo trong PR body. +- **Khả năng publish linh hoạt**: + - ưu tiên `.npmrc` có sẵn; + - tự thêm auth line khi có `NPM_TOKEN`; + - fallback sang trusted publishing khi có OIDC env. +- **Tạo GitHub Releases là tùy chọn** (`createGithubReleases`) và phụ thuộc package/tag được phát hiện từ output publish. + +## 5) Cách đọc code hiệu quả cho người mới + +- Bắt đầu từ `src/index.ts` để hiểu router điều kiện. +- Sau đó đọc `runVersion` và `runPublish` trong `src/run.ts`. +- Khi thấy thao tác git/network, nhảy sang `src/git.ts` và `src/octokit.ts`. +- Cuối cùng đọc test `src/run.test.ts`, `src/utils.test.ts` để xem các edge-case và expected behavior. + +## 6) Gợi ý học tiếp theo + +- **Changesets core concepts**: changeset file, versioning, pre-release mode. +- **GitHub Actions runtime**: input/output, environment, token model. +- **Octokit/GitHub REST API**: pull requests, releases, rate limit + retry. +- **Testing strategy**: snapshot testing, fixture-based tests cho các case nhiều package. +- **Monorepo package tooling**: `@manypkg/get-packages` và cách phân biệt root package vs workspace packages. + +Nếu mới hoàn toàn, hãy chạy test trước khi sửa code (`yarn test`), rồi thử trace một test case trong `src/run.test.ts` để bám theo toàn bộ luồng. diff --git a/README.md b/README.md index ebfda456..e6249d96 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ This action for [Changesets](https://github.com/changesets/changesets) creates a pull request with all of the package versions updated and changelogs updated and when there are new changesets on [your configured `baseBranch`](https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#basebranch-git-branch-name), the PR will be updated. When you're ready, you can merge the pull request and you can either publish the packages to npm manually or setup the action to do it for you. + +## New contributor notes + +- Vietnamese beginner guide: [`BEGINNER_GUIDE.vi.md`](./BEGINNER_GUIDE.vi.md) + ## Usage ### Inputs