Skip to content

docs: add Issue Form templates for the Tabularis migration flow - #62

Merged
aesslinger merged 1 commit into
mainfrom
56-issue-form-templates
Sep 3, 2026
Merged

docs: add Issue Form templates for the Tabularis migration flow#62
aesslinger merged 1 commit into
mainfrom
56-issue-form-templates

Conversation

@aesslinger

Copy link
Copy Markdown
Collaborator

Summary

Adds three GitHub Issue Form templates under .github/ISSUE_TEMPLATE/ that the Tabularis builtin-to-plugin migration flow pre-fills via query params keyed on each form element's id (per the design in TabularisDB/tabularis#685, issue #56):

  • migration-failure.yml — filed when switching a connection from the builtin postgres driver to this plugin fails. Failure-mode dropdown (process vs. connection), version/OS/error fields. Labels: migration
  • capability-gap.yml — filed when a connection uses a builtin-only feature the plugin doesn't yet cover. Labels: capability-gap
  • bug_report.yml — general bug report from the standing "Report a plugin issue" link in Settings. Labels: bug

Also created the migration and capability-gap labels on the repo (bug already existed), so each template's labels: frontmatter auto-applies them going forward.

Part 2 of #56 (the builtin-vs-plugin capability diff) needs no separate work here — it already runs as part of every plugin release; gaps it turns up should be filed with the new capability-gap template.

Verification

All three templates validated before commit:

  • ✅ Parse as YAML (Ruby stdlib, offline)
  • ✅ Conform to the official GitHub Issue Forms JSON schema (json.schemastore.org/github-issue-forms.json) — npx ajv-cli validatevalid for all three
  • ✅ Form-element ids use only ^[a-zA-Z0-9_-]+$ (underscores allowed per schema pattern + GitHub form-schema docs)
  • ✅ All ids unique within each form; markdown elements carry no id (per schema/docs)
  • ✅ Every type is in the allowed set (input/textarea/dropdown/markdown); the dropdown's options key is present
  • ✅ Prefill contract holds: every id the app targets (failure_mode, plugin_version, app_version, os, error, feature, …) exists in its template, so ?template=…&id=value query params resolve correctly
  • ✅ All referenced labels (migration, capability-gap, bug) exist on the repo

Content is verbatim from #56.

Versioning

docs: type — no release impact per the README's type→bump table. Labeled prerelease:beta (current channel) to satisfy CI's required prerelease:* label; CI's version suggestion will correctly resolve to no change.

Closes #56.

Add three GitHub Issue Form templates under .github/ISSUE_TEMPLATE/
that the Tabularis builtin-to-plugin migration flow pre-fills via query
params keyed on each form element's id:

- migration-failure.yml: filed when switching a connection from the
  builtin postgres driver to this plugin fails (failure_mode dropdown,
  version/OS/error fields, labels: migration)
- capability-gap.yml: filed when a connection uses a builtin-only
  feature the plugin doesn't yet cover (labels: capability-gap)
- bug_report.yml: general bug report from the standing 'Report a plugin
  issue' link in Settings (labels: bug)

Verified against the official schemastore Issue Forms JSON schema
(all three valid), with unique underscore-legal ids per form, markdown
elements carrying no id, and the referenced labels (migration,
capability-gap, bug) all present on the repo.

Closes #56
@aesslinger aesslinger added the prerelease:beta Version suggestion targets a beta prerelease label Sep 3, 2026
@aesslinger aesslinger self-assigned this Sep 3, 2026
@aesslinger
aesslinger merged commit 320bce6 into main Sep 3, 2026
13 of 14 checks passed
@aesslinger
aesslinger deleted the 56-issue-form-templates branch September 3, 2026 12:44
aesslinger added a commit that referenced this pull request Sep 4, 2026
Ships the configurable pool-size feature (PR #63, porting tabularis#681)
and three dependency bumps (PRs #55/#59/#60), plus the migration Issue
Form templates (PR #62).

Headline change: a poolMaxSize driver setting (default 10, clamped to
1-64, parsed from u64/i64/string, zero/invalid -> default) received via
the initialize RPC. Restores pool-size parity with the built-in driver
(build_pool previously never set max_size, so deadpool defaulted to
cpu×2 — up to ~32 on a 16-thread machine — vs. the built-in's pinned 10).

Verified: .tabularium re-validated as valid JSON with version matching
the upcoming v1.0.0-beta.10 tag; cargo build/test (133 unit + 8 live-DB
against the local pg-tabularis-test container)/clippy/fmt all pass; the
release binary returns a valid initialize JSON-RPC response.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

prerelease:beta Version suggestion targets a beta prerelease

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Issue Form templates + capability parity diff for the Tabularis migration flow

1 participant