GitHub

Use the @bijection/connectors/github entrypoint to declare GitHub resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Repository issues	`observations`	Evidence-checked repository
Repository issues	`issues`	Current issue observations

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Repository issues

observations: Evidence-checked repository

The following example matches configuration standard.

import { github } from "@bijection/connectors/github";
import { makeFunctionReference } from "bijection/server";

export const repository = github.repository.observations({
  governingRule: makeFunctionReference<"query", any, [null]>("policies:write"),
});

Inferred record types

issues: {
  "number": number;
  "title": string;
  "state": string;
  "body": string | null;
  "updated_at": string;
  "comments": number;
}

comments: {
  "id": number;
  "issue_url": string;
  "body": string | null;
  "updated_at": string;
}

The function references identify application policy queries. Implement those policies in your application; the references alone grant no authority.

Configuration: standard

Case: github/repository/observations/standard. Connection and resource configuration are declared by this exact case. Credential kind: github. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`owner`	string	Yes	Shared connection
`repository`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "github",
    "output": {
      "kind": "bundle",
      "collections": [
        "comments",
        "issues"
      ]
    },
    "credential_kind": "github",
    "connection_fields": [
      "owner",
      "repository"
    ],
    "address": {
      "kind": "path",
      "base": "https://api.github.com/repos",
      "segments": [
        {
          "field": "owner"
        },
        {
          "field": "repository"
        }
      ]
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "owner": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      },
      "repository": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: comments

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	No continuation
Gap	Not applicable
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "comments": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange comments",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "listener changes",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "none",
  "retentionMs": null,
  "gap": "not_applicable",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Collection: issues

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "issues": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange issues",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "listener changes",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {
    "commentOnIssue": {
      "target": "issues",
      "delivery": "single_attempt",
      "condition": "unconditional",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    },
    "stampIssue": {
      "target": "issues",
      "delivery": "single_attempt",
      "condition": "unconditional",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    }
  }
}

Commands

Command	Target	Condition	Delivery
`commentOnIssue`	issues	Unconditional	Single dispatch attempt
`stampIssue`	issues	Unconditional	Single dispatch attempt

Commands, occurrences and artifacts

{
  "records": {
    "comments": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": true,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "comments": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange comments",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "listener changes",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "none",
        "retentionMs": null,
        "gap": "not_applicable",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    },
    "issues": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": true,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "issues": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange issues",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "listener changes",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {
          "commentOnIssue": {
            "target": "issues",
            "delivery": "single_attempt",
            "condition": "unconditional",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          },
          "stampIssue": {
            "target": "issues",
            "delivery": "single_attempt",
            "condition": "unconditional",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          }
        }
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {
    "commentOnIssue": {
      "target": "issues",
      "condition": {
        "kind": "unconditional"
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "stated",
          "unit": "days",
          "value": 1
        },
        "max_delivery_hours": 1
      }
    },
    "stampIssue": {
      "target": "issues",
      "condition": {
        "kind": "unconditional"
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "stated",
          "unit": "days",
          "value": 1
        },
        "max_delivery_hours": 1
      }
    }
  }
}

Recorded checks

Requirement	Scope	Evidence	Result
listener-custody-before-ack	{“kind”:“listener”,“collection”:“issues”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
listener-duplicate-delivery	{“kind”:“listener”,“collection”:“issues”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
page-publication-recovery	{“kind”:“collection”,“name”:“comments”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
page-publication-recovery	{“kind”:“collection”,“name”:“issues”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“issues”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“issues”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
command-response-lost	{“kind”:“command”,“name”:“commentOnIssue”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
command-response-lost	{“kind”:“command”,“name”:“stampIssue”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
identity-account	{“kind”:“connection”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

issues: Current issue observations

The following example matches configuration standard.

import { github } from "@bijection/connectors/github";
export const issues = github.repository.issues();

Inferred record types

{
  "id": string;
  "number": number;
  "state": "CLOSED" | "OPEN";
  "title": string;
  "updatedAt": string;
  "url": string;
}

Configuration: standard

Case: github/repository/issues/standard. Connection and resource configuration are declared by this exact case. Credential kind: github. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`baseUrl`	string	Yes	Shared connection
`owner`	string	Yes	Shared connection
`repository`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "github",
    "output": {
      "kind": "single",
      "collection": "records"
    },
    "credential_kind": "github",
    "connection_fields": [
      "baseUrl",
      "owner",
      "repository"
    ],
    "address": {
      "kind": "setup",
      "field": "baseUrl"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "baseUrl": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      },
      "owner": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      },
      "repository": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: records

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Deletion detection unsupported
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "records": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange records",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "unsupported",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "records": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": false,
      "reconciliation": false,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "records": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange records",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "unsupported",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“records”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“records”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“records”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable
identity-account	{“kind”:“connection”}	Portable fixtures exercise this captured GitHub declaration. No exact-source native or hosted GitHub qualification receipt is attached.	Execution result unavailable

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Repository-scoped issue and comment observations. Closing an issue is a value change. Filtered pages and webhook hints do not establish full membership or deletion. Compiled declaration examples and configuration details are published in the connector reference. Configure the typed setup fields with bind and keep credentials in native credential custody. Use github.credential("inventory-name") for a private credential reference. Compiled declaration examples and configuration details are published in the connector reference. This is a bundle of independently scheduled tables. Use defineSyncedTable({ source: repository.tables.issues }) and the same constructor for comments. It promises no joint publication across those tables. Text commands accept { text: string } and require an application governing rule. They use single-attempt delivery: a successful send is attributable to its own retained response; a lost response remains unknown. The separately named audit stamp writes only the operation identity and can reconcile by exact equality, including duplicate detection. Neither command promises provider idempotency or request expiry. Package replay is not live qualification. See the generated catalog for exact declared scenarios and evidence status.

Captured GraphQL issue observations

@bijection/connectors/github exposes github.repository.issues() over captured GraphQL and ordinary native HTTP acquisition. Compiled declaration examples and configuration details are published in the connector reference. Use defineSyncedTable({ source: issues }) and your normal read policy. Bind with setup { baseUrl: "https://api.github.com/graphql", owner: "ORG", repository: "REPO" } and github.credential("GITHUB_READ_TOKEN"). The private credential needs repository and issue access. Authentication belongs to the credential inventory, never setup or operation documents. Identification binds the viewer ID and repository node ID. Queries set followRenames: false; changed or inaccessible repository coordinates stop progress. The list selects id, number, title, state, updatedAt and url, in creation order with 100 records per page. IDs and cursors remain opaque. updatedAt is an observed timestamp, not a unique revision or write condition. This live traversal establishes no consistent snapshot, complete change history or deletion of missing issues. Null nodes, inaccessible repositories, partial errors and malformed pages refuse publication and cursor progress. Earlier independently committed pages remain committed. No commands, point-absence guarantee, nested pagination or bulk-export behavior is inferred. The schema is a reviewed field projection of GitHub’s public SDL. Its header retains the full source SHA-256 and retrieval date. Selected fields retain all arguments and referenced input types. Directional DateTime and URI mappings explicitly use strings. Regenerate offline using BIJECTION_GRAPHQL_EXECUTABLE=/path/to/bijection-graphql node dev/graphql-codegen.mjs; --check compares the generated module and contract. Provider cost is not inferred from selection counts. Use the existing connection budget for deployment-specific allowances. This recipe does not decode extensions.cost or promise provider quota. References: public schema and pagination. Portable fixtures establish declaration behavior. Hosted GitHub qualification is unestablished and remains opt-in.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Availability

Resources and modes

Repository issues

observations: Evidence-checked repository

Configuration: standard

issues: Current issue observations

Configuration: standard

Provider guidance

Captured GraphQL issue observations

Provider references

Source and evidence

​Availability

​Resources and modes

​Repository issues

​observations: Evidence-checked repository

​Configuration: standard

​issues: Current issue observations

​Configuration: standard

​Provider guidance

​Captured GraphQL issue observations

​Provider references

​Source and evidence

Availability

Resources and modes

Repository issues

observations: Evidence-checked repository

Configuration: standard

issues: Current issue observations

Configuration: standard

Provider guidance

Captured GraphQL issue observations

Provider references

Source and evidence