diff options
| author | Mehmet Samet Duman <yongdohyun@projecttick.org> | 2026-04-04 19:47:58 +0300 |
|---|---|---|
| committer | Mehmet Samet Duman <yongdohyun@projecttick.org> | 2026-04-04 19:47:58 +0300 |
| commit | 8d0d919fbf43230148da7533519ed0ffdfaa4197 (patch) | |
| tree | 27e352d6ca09910e577ec27a10659814e88b15b9 /ci/github-script/README.md | |
| parent | fce202465d4fede9e19d4d057eebbaa702291652 (diff) | |
| download | Project-Tick-8d0d919fbf43230148da7533519ed0ffdfaa4197.tar.gz Project-Tick-8d0d919fbf43230148da7533519ed0ffdfaa4197.zip | |
NOISSUE add GitHub Actions scripts for PR preparation and review management
- Introduced `prepare.js` to validate PR mergeability and branch targeting.
- Added `reviews.js` for automated review dismissal and posting.
- Created `run` script to execute actions with GitHub context.
- Implemented rate limiting in `withRateLimit.js` to manage API requests.
- Added `supportedBranches.js` for branch classification logic.
- Created `update-pinned.sh` for updating pinned dependencies.
- Added `pinned.json` to manage pinned Nix dependencies.
- Updated `libnbtplusplus` version from 2.3 to 3.0 and adjusted README accordingly.
Signed-off-by: Mehmet Samet Duman <yongdohyun@projecttick.org>
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 +``` |
