Skip to content

feat: update package description to more accurately describe functionality #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 14, 2025
Merged

feat: update package description to more accurately describe functionality #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/scripts/example.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}`);

Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down
8 changes: 6 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -24,7 +24,11 @@
"github-api",
"utilities",
"rest-api",
"octokit"
"octokit",
"workflow",
"context",
"core",
"github-script"
],
"author": "tkstang",
"license": "MIT",
Expand Down