From d9265b9931e1b0bd5773959257ad9a489d700504 Mon Sep 17 00:00:00 2001 From: Thomas Stang Date: Sun, 14 Sep 2025 18:24:32 -0500 Subject: [PATCH] feat: update package description to more accurately describe functionality --- .github/scripts/example.ts | 2 +- README.md | 4 ++-- package.json | 8 ++++++-- 3 files changed, 9 insertions(+), 5 deletions(-) diff --git a/.github/scripts/example.ts b/.github/scripts/example.ts index 118e058..5c7dc88 100644 --- a/.github/scripts/example.ts +++ b/.github/scripts/example.ts @@ -71,7 +71,7 @@ export default async function run({ core, github, context, args }: Ctx) { const branchExists = await checkBranchExists({ ctx, repo: repoInfo, - branchName: args.testBranch, + branch: args.testBranch, }); core.info(`✅ Branch check: "${args.testBranch}" exists = ${branchExists}`); diff --git a/README.md b/README.md index ac16dd8..a287471 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # github-typescript-utils -**Utility functions for GitHub REST API interactions with [`github-typescript`](https://github.com/tkstang/github-typescript).** +**TypeScript utilities for GitHub Actions workflows with [`github-typescript`](https://github.com/tkstang/github-typescript).** -This package provides a comprehensive set of TypeScript utilities for interacting with the GitHub REST API within GitHub Actions workflows. Designed specifically for use with the `github-typescript` composite action, these utilities simplify common GitHub operations like managing comments, pull requests, and repository interactions. +This package provides a comprehensive set of TypeScript utilities for GitHub Actions workflows, including REST API interactions, Octokit helpers, context utilities, and common workflow functions. Designed specifically for use with the `github-typescript` composite action, these utilities simplify working with GitHub's API, Actions context, and core functionality. ## Features diff --git a/package.json b/package.json index 9735fa6..a0c555b 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "github-typescript-utils", "version": "0.2.0", - "description": "Utility functions for GitHub REST API interactions with github-typescript", + "description": "TypeScript utilities for GitHub Actions workflows - REST API, Octokit, context helpers, and common workflow functions", "type": "module", "main": "./dist/index.js", "module": "./dist/index.js", @@ -24,7 +24,11 @@ "github-api", "utilities", "rest-api", - "octokit" + "octokit", + "workflow", + "context", + "core", + "github-script" ], "author": "tkstang", "license": "MIT",