ask-github 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81872d8db5d4f3e8a63eed5fb7bb856daa386f447f522331d8c30b97400ad0a5
-  data.tar.gz: d86d708a8e4fbaac994a2cedaab52458434fae36b08f9c7cae98d8b70b9ae079
+  metadata.gz: f64d61d784bb31f0281d5aabedd9abe2937b335b25a85dee0d8246dbe7e6745b
+  data.tar.gz: d81bfb900b6d5c3f9cdfd7b5b6f6553ab9b5a93ecacbef219d5fda968dd3eb29
 SHA512:
-  metadata.gz: 925160b0799b93e9c2665429c319594913a9346ab461ca9d14ba90809a7e264715c729f5513365681845f48f247ab468f6a91169361089f6346e52c910cf58e1
-  data.tar.gz: 0f44993f6e054c65512ddbed2a2ea0b2cef9e0436093e9edf0d224b55fbe94872964606ab0099eb0476036eb3adaa6a747e873f9cb2e3736d413f4eac2881c68
+  metadata.gz: 9a8b8fe7c51f63e6a78e92f302010e10d3e7da2ad990b2f6b967d0624be0ab224c448a042dd8925459777710c370bbe787a7cd1596153623998907427c2a032a
+  data.tar.gz: 29b96dd81509ba2323990ebfd8742e580058840ac29e41e089cdcc918611932ae6338b3ef954b96b14f8dd6ad795d4f0faebc6d4d6cf2bcdfad42616a6f37c06

data/lib/ask/github/version.rb

@@ -2,6 +2,6 @@
 
 module Ask
   module GitHub
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/lib/ask/skills/github.use_github/SKILL.md

@@ -0,0 +1,86 @@
+---
+name: github.use_github
+description: How to navigate the GitHub API with Octokit — discover endpoints, handle auth, pagination, and errors
+---
+
+Use this skill when you need to interact with GitHub — reading issues, pull
+requests, repository contents, search, or managing projects using code tools.
+
+## Step 1: Get the Client
+
+```ruby
+client = Ask::GitHub.client
+```
+
+This returns an authenticated Octokit client. It expects a valid GitHub personal
+access token resolved via `Ask::Auth.resolve(:github_token)`.
+
+If you get an auth error, read `Ask::GitHub::Context::AUTH_HOW` for token setup.
+
+## Step 2: Explore the Context
+
+The gem ships with structured context you should reference:
+
+```ruby
+Ask::GitHub::Context::DOCS_URL    # GitHub REST API docs
+Ask::GitHub::Context::GEM_DOCS    # Octokit Ruby docs
+Ask::GitHub::Context::QUICK_START # Copy-paste examples
+Ask::GitHub::Context::GEM_NAME    # "octokit"
+```
+
+The `QUICK_START` constant has basic usage examples for common operations
+(issues, pull requests, contents, search).
+
+## Step 3: Discover Available Methods
+
+Rather than assuming which methods exist, use code tools to explore the client:
+
+```ruby
+# List all public methods (filter out Object basics)
+Code.new.call(code: "
+  client = Ask::GitHub.client
+  puts (client.methods - Object.methods).sort.join(\"\\n\")
+")
+```
+
+Octokit methods follow REST API patterns:
+- `client.issues("owner/repo")` — list issues
+- `client.pull_requests("owner/repo")` — list PRs
+- `client.contents("owner/repo", path: "README.md")` — read file
+- `client.search_issues("query")` — search across repos
+- `client.create_issue("owner/repo", "Title", "body")` — create issue
+
+For method specifics, read the Octokit source:
+```ruby
+Grep.new.call(pattern: "def issues", path: "$GEM_PATH/octokit-*/lib")
+```
+
+## Step 4: Authentication Errors
+
+Auth failures are converted to `Ask::Auth::InvalidCredential`. For detailed
+error guidance, use:
+
+```ruby
+Ask::GitHub::Errors.for("Octokit::NotFound")
+Ask::GitHub::Errors.status_code_description(404)
+Ask::GitHub::Errors::RATE_LIMIT
+```
+
+Common scenarios:
+- **401/403**: Token invalid or missing scopes → check token at GitHub settings
+- **404**: Resource doesn't exist or is private → verify owner/repo and access
+- **429**: Rate limited → wait and retry (5,000 req/hr with token)
+
+## Step 5: Pagination
+
+Octokit auto-paginates by default (`auto_paginate: true`, `per_page: 100`).
+For very large result sets, you can iterate manually using the response's
+`rels` (relations) links.
+
+## Step 6: Fallback Strategy
+
+If Octokit doesn't have a convenience method for what you need:
+1. Check `Ask::GitHub::Context::DOCS_URL` for the REST API endpoint
+2. Use `client.get("/endpoint")` for custom REST requests
+3. Use the GraphQL API via `client.post("/graphql", { query: "..." })` for complex queries
+4. For search, use `client.search_issues("...")` which supports GitHub's query syntax

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ask-github
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Kaka Ruto
@@ -137,6 +137,7 @@ files:
 - lib/ask/github/context.rb
 - lib/ask/github/error_guide.rb
 - lib/ask/github/version.rb
+- lib/ask/skills/github.use_github/SKILL.md
 homepage: https://github.com/ask-rb/ask-github
 licenses:
 - MIT