diff options
Diffstat (limited to 'ci/github-script/README.md')
| -rw-r--r-- | ci/github-script/README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/ci/github-script/README.md b/ci/github-script/README.md new file mode 100644 index 0000000000..f0965d693c --- /dev/null +++ b/ci/github-script/README.md @@ -0,0 +1,27 @@ +# GitHub CI Scripts — Project Tick + +JavaScript-based CI scripts using [`actions/github-script`](https://github.com/actions/github-script). + +## Local Testing + +```bash +cd ci/github-script +nix-shell # sets up Node.js + dependencies +gh auth login # ensure GitHub CLI is authenticated +``` + +### Available Commands + +#### Lint Commits +Validates commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format. + +```bash +./run lint-commits YongDo-Hyun Project-Tick 123 +``` + +#### Prepare +Checks PR mergeability and validates branch targeting. + +```bash +./run prepare YongDo-Hyun Project-Tick 123 +``` |