@agentsmd/preset-github 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;CAUP,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,eAAO,MAAM,YAAY;;;;;;;;;;CAWP,CAAC"}
package/dist/index.js CHANGED
@@ -15,6 +15,7 @@ export const githubPreset = {
15
15
  nextSteps: [
16
16
  "GitHub 저장소 설정에서 머지 방식을 'Allow merge commits'만 허용하세요. → docs/github.md",
17
17
  "main 브랜치 룰셋을 만들고 CI 검사를 필수 체크로 거세요. → docs/github.md",
18
+ "GitHub Actions를 쓰면 PR마다 문서 지도를 검사하는 xoruddl/agentsmd-kit Action을 거세요. → docs/github.md",
18
19
  ],
19
20
  };
20
21
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,6BAA6B;IAC1C,QAAQ,EAAE,aAAa,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7D,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,gCAAgC,EAAE,CAAC;IAC1E,KAAK,EAAE,CAAC,kCAAkC,CAAC;IAC3C,SAAS,EAAE;QACT,uEAAuE;QACvE,sDAAsD;KACvD;CACe,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG;IAC1B,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,6BAA6B;IAC1C,QAAQ,EAAE,aAAa,CAAC,IAAI,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7D,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,gCAAgC,EAAE,CAAC;IAC1E,KAAK,EAAE,CAAC,kCAAkC,CAAC;IAC3C,SAAS,EAAE;QACT,uEAAuE;QACvE,sDAAsD;QACtD,wFAAwF;KACzF;CACe,CAAC"}
@@ -38,7 +38,45 @@ PR 리뷰를 확인할 때는 마지막 두 명령으로 리뷰와 줄 단위
38
38
  ## CI 연결
39
39
 
40
40
  이 프리셋은 CI 설정 파일을 설치하지 않는다. GitHub를 써도 CI는 GitHub Actions, Jenkins 등 무엇이든 쓸 수 있기 때문이다.
41
- GitHub Actions를 쓰고 Git 프리셋의 PR 규칙 검사(`.githooks/check-pr`)를 함께 설치했다면, 아래 파일을 `.github/workflows/conventions.yml`로 만든다.
41
+ GitHub Actions를 쓴다면 아래 두 워크플로를 만든다.
42
+
43
+ ### 문서 지도 검사
44
+
45
+ 문서를 손으로 더하거나 빼거나 옮겼을 때 `AGENTS.md`가 그대로 맞는지 PR마다 검사한다. 아래 파일을 `.github/workflows/agentsmd.yml`로 만든다.
46
+
47
+ ```yaml
48
+ name: agentsmd
49
+
50
+ on:
51
+ pull_request:
52
+
53
+ permissions:
54
+ contents: read
55
+
56
+ jobs:
57
+ agentsmd:
58
+ runs-on: ubuntu-latest
59
+ steps:
60
+ - uses: actions/checkout@v7
61
+ - uses: xoruddl/agentsmd-kit@v0
62
+ ```
63
+
64
+ `agentsmd check`와 같은 것을 검사한다. 문서 지도 파일이나 문서 디렉터리 위치가 기본값과 다르면 `with:`로 넘긴다. 입력 이름은 `agentsmd check`의 옵션과 같다.
65
+
66
+ ```yaml
67
+ - uses: xoruddl/agentsmd-kit@v0
68
+ with:
69
+ root: packages/web # 검사할 저장소 루트 (기본 .)
70
+ docs: guides # 문서 디렉터리 (기본 docs)
71
+ ```
72
+
73
+ 만든 뒤 룰셋의 필수 체크에 `agentsmd`를 추가한다.
74
+ 이 Action은 Docker 이미지(`ghcr.io/xoruddl/agentsmd`)로 돌므로 Linux 러너(`ubuntu-*`)에서만 쓸 수 있다. 호출한 job의 Node 설정에는 영향을 주지 않는다.
75
+ GitLab CI·Jenkins에서 같은 이미지를 쓰는 방법은 Git 작업 규칙 문서의 "문서 지도 검사를 CI에 연결" 절에 있다.
76
+
77
+ ### PR 규칙 검사
78
+
79
+ Git 프리셋의 PR 규칙 검사(`.githooks/check-pr`)를 함께 설치했다면, 아래 파일을 `.github/workflows/conventions.yml`로 만든다.
42
80
 
43
81
  ```yaml
44
82
  name: Conventions
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@agentsmd/preset-github",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "description": "GitHub 저장소용 AI 작업 지침 프리셋 (이슈·PR 템플릿, 저장소 설정·CI 연결 안내)",
5
5
  "keywords": [
6
6
  "agents.md",
@@ -36,7 +36,7 @@
36
36
  "access": "public"
37
37
  },
38
38
  "dependencies": {
39
- "@agentsmd/core": "0.5.0"
39
+ "@agentsmd/core": "0.6.0"
40
40
  },
41
41
  "scripts": {
42
42
  "build": "tsc -p tsconfig.build.json",