Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions .cursor/rules/no-local-dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# No Local Dependencies

Never create local dependencies between projects. Never use `file://` URLs in package.json dependencies.

All dependencies must be published packages with proper version numbers from npm registry or equivalent package registries.

4 changes: 3 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ Thumbs.db
# Documentation that shouldn't be in package
*.md
!README.md
!guide/**/*.md

# Include dist directory with all its contents
# Include dist and guide directories with all their contents
!dist/
!guide/

78 changes: 78 additions & 0 deletions guide/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# @eldrforge/github-tools - Agentic Guide

## Purpose

GitHub API utilities for automation. Provides PR management, issue tracking, workflow monitoring, and release note generation.

## Key Features

- **Pull Request Management** - Create, update, and merge PRs
- **Issue Tracking** - Create and manage GitHub issues
- **Release Notes** - Generate and publish release notes
- **Workflow Monitoring** - Check CI/CD status
- **Authentication** - GitHub token management

## Usage

```typescript
import {
createPullRequest,
createIssue,
publishReleaseNotes,
getPRStatus
} from '@eldrforge/github-tools';

// Create pull request
const pr = await createPullRequest({
owner: 'myorg',
repo: 'myrepo',
title: 'Feature: Add new command',
body: 'Description...',
head: 'feature-branch',
base: 'main'
});

// Create issue
const issue = await createIssue({
owner: 'myorg',
repo: 'myrepo',
title: 'Bug: Fix validation',
body: 'Details...'
});

// Publish release notes
await publishReleaseNotes({
owner: 'myorg',
repo: 'myrepo',
tag: 'v1.0.0',
notes: 'Release notes...'
});
```

## Dependencies

- @eldrforge/git-tools - Git operations
- @octokit/rest - GitHub API client

## Package Structure

```
src/
├── github.ts # GitHub API client
├── issues.ts # Issue management
├── releaseNotes.ts # Release note publishing
├── errors.ts # Error types
├── types.ts # Type definitions
├── logger.ts # Logging utilities
└── index.ts
```

## Key Exports

- `createPullRequest()` - Create GitHub PR
- `mergePullRequest()` - Merge PR
- `createIssue()` - Create issue
- `publishReleaseNotes()` - Publish release notes
- `getPRStatus()` - Check PR CI status
- `getLatestRelease()` - Get latest release info

12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@eldrforge/github-tools",
"version": "0.1.19",
"version": "0.1.20",
"description": "GitHub API utilities for automation - PR management, issue tracking, workflow monitoring",
"main": "dist/index.js",
"type": "module",
Expand All @@ -11,7 +11,8 @@
}
},
"files": [
"dist"
"dist",
"guide"
],
"repository": {
"type": "git",
Expand Down Expand Up @@ -41,7 +42,7 @@
"author": "Tim O'Brien <tobrien@discursive.com>",
"license": "Apache-2.0",
"dependencies": {
"@eldrforge/git-tools": "^0.1.17",
"@eldrforge/git-tools": "^0.1.18",
"@octokit/rest": "^22.0.0"
},
"peerDependencies": {
Expand Down