GitHub Issues · 0.1.0

GitHub Issues Block

<!-- block-metadata:start -->

Verified BloxSmith versions: 1.0.9 (bundled-block tests; see test evidence).

<!-- block-metadata:end -->

Role

github_issues calls the GitHub Issues REST API to support maintainer actions from a workflow.

Files

• block.py: GitHub REST request construction, action dispatch, token masking, runtime outputs, and UI rendering.
• model.json: input/output ports, default GitHub settings, and runtime capabilities.
• inspector_panel.html: block-owned inspector UI for repository, token, action, issue, labels, assignees, and dry-run settings.
• block_modal.html: wide tabbed modal layout for full block editing.
• node_card.html: compact canvas card content.
• assets/css/block_modal.css: block-owned modal layout and responsive rules.
• assets/js/block_modal.js: block-owned modal tab switching.
• tests/F5.24_github_issues_block.py: block-local functional, UI, centralized, and zeromq_active tests.

Ports

• Inputs:
  • actions (id: 1): optional JSON object or plain text. It can contain either a single-action payload or the standard multi-actions payload described below. Plain text can be used as body when the selected single action needs a body. The input port must be named actions; payload is not a supported input name.
• Outputs:
  • result (id: 1): normalized JSON result containing ok, action, repo, data, and safe diagnostics.
  • summary (id: 2): short text summary for displays or logs.

Configuration

• api_base_url: GitHub-compatible API root. Default: https://api.github.com.
• token: GitHub token. If empty at runtime, GITHUB_TOKEN is used.
• repo: repository in owner/repo format.
• action: one of list_issues, view_issue, create_issue, comment_issue, add_labels, remove_label, assign_issue, close_issue, reopen_issue.
• issue_number: issue number required by issue-scoped actions.
• state: open, closed, or all for list_issues.
• title: issue title for create_issue.
• body: issue body or comment body.
• labels: comma-separated labels.
• assignees: comma-separated GitHub logins.
• state_reason: close reason for close_issue.
• include_pull_requests: when false, list_issues removes GitHub PR objects returned by the Issues endpoint.
• include_comments: when true, read actions enrich each issue JSON with comments_data, using GET /issues/{issue_number}/comments. It is disabled by default to avoid extra API calls.
• dry_run: when true, write actions emit the planned request without calling GitHub.
• per_page: result page size for list_issues, capped at 100.
• timeout_sec: HTTP timeout.

Runtime Behavior

execute_runtime() reads repository, token, dry-run, API base URL, timeout, and related connection settings from the block configuration. The optional actions input provides only action-level data. The block validates the selected action or multi-action sequence, calls GitHub REST endpoints with urllib, then emits:

• JSON result on result;
• readable summary on summary.

Read actions can be attempted without a token for public repositories. When include_comments is enabled, list_issues and view_issue add a comments_data array to each returned issue object. This performs one extra comments request per issue, so it should stay disabled unless comment content is required. Write actions require a token unless dry_run is true. The token is never included in logs, metadata, or outputs.

For a standard multi-actions payload, issue_number is read once at the root and actions are executed in order. Supported entries are add_labels, remove_labels, add_comment, and close_issue. remove_labels reuses the existing remove_label implementation, and add_comment reuses comment_issue. If one action fails, the block returns a structured result containing successful actions, the failed action with its error, and remaining actions marked skipped.

The same implementation runs in One Shot Simulation (centralized) and Active Runtime (zeromq_active) through the generic block executor.

UI Behavior

The inspector and wide modal expose repository, token, action, issue fields, labels, assignees, dry-run, paging, and comment options. Sensitive token values are not echoed back in HTML. Editable fields stay local until the user clicks Apply; empty sensitive fields keep the existing token. The modal declares data-block-runtime-refresh="autonomous", so block-owned tabs and draft settings stay stable while runtime polling is active.

Examples

Single-action input on actions to list open issues while repo stays in config:

{
  "action": "list_issues",
  "state": "open"
}

List issues with comment contents by enabling include_comments in the block configuration. Each issue in data then contains comments_data:

{
  "data": [
    {
      "number": 42,
      "title": "Example",
      "comments": 2,
      "comments_data": [
        { "id": 101, "body": "First comment" }
      ]
    }
  ]
}

Comment on issue 42 with a text input:

{
  "action": "comment_issue",
  "issue_number": 42
}

Standard multi-actions input on actions:

{
  "issue_number": 123,
  "actions": [
    { "action": "add_labels", "labels": ["status:ready-for-dev", "priority:p2"] },
    { "action": "remove_labels", "labels": ["todo"] },
    { "action": "add_comment", "body": "Triage comment." },
    { "action": "close_issue", "state_reason": "not_planned" }
  ]
}

repo, token, dry_run, api_base_url, timeout_sec, and other connection/runtime settings stay in the block configuration and must not be supplied by this input payload.

Maintenance Notes

GitHub Issues behavior belongs in this block. Do not add GitHub Issues-specific branches to the orchestrator or active runtime worker; use the generic block executor contract instead.

Compatibility policy

compatibility.json records HackInvent's verified BloxSmith versions and test evidence. Only the versions listed above have been verified, using the block-owned suites in a bundled-block test installation. This is not a certification of managed-package installation, every browser/OS, or live provider availability. Other framework versions are unverified, not necessarily incompatible.

The block-version badge follows model.json, not a published Git tag. unversioned means that no block release version is declared; no number is inferred from the framework version. The framework still uses model.json for its runtime/install contract; the tester-owned JSON does not replace it. Official integration tests run in the private bloxmith-blocs workspace. Test helpers and the proprietary framework are not bundled in this public block repository.