Skip to content

Commit 4357402

Browse files
committed
feat: update readme with details about utils package
1 parent f7cc390 commit 4357402

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,34 @@ A: No. It wraps it, so you keep Octokit/context ergonomics and its features (ret
343343

344344
---
345345

346+
## Related Projects
347+
348+
### 📦 github-typescript-utils
349+
**[NPM](https://www.npmjs.com/package/github-typescript-utils) | [GitHub](https://github.com/tkstang/github-typescript-utils)**
350+
351+
A companion TypeScript utilities package for GitHub Actions workflows. Provides REST API helpers, context utilities, and common workflow functions.
352+
353+
```typescript
354+
// Example: .github/scripts/pr-manager.ts
355+
import { getRepoInfo, createStickyComment } from 'github-typescript-utils';
356+
357+
export default async function run({ core, github, context, args }) {
358+
const ctx = { core, github, context };
359+
const repo = getRepoInfo(ctx);
360+
361+
await createStickyComment({
362+
ctx, repo,
363+
issueNumber: context.issue.number,
364+
identifier: 'welcome',
365+
body: `Welcome! This PR is for ${repo.owner}/${repo.repo}`
366+
});
367+
}
368+
```
369+
370+
See the [utils README](https://github.com/tkstang/github-typescript-utils#readme) for full usage and installation.
371+
372+
---
373+
346374
## License
347375

348376
MIT

0 commit comments

Comments
 (0)