Skip to content

fix(gh): move issue template to ISSUE_TEMPLATE/ dir - #489

Merged
ezolenko merged 1 commit into
ezolenko:masterfrom
agilgur5:fix-gh-issue-template
Jul 23, 2026
Merged

fix(gh): move issue template to ISSUE_TEMPLATE/ dir#489
ezolenko merged 1 commit into
ezolenko:masterfrom
agilgur5:fix-gh-issue-template

Conversation

@agilgur5

@agilgur5 agilgur5 commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Summary

Fix the issue template not working by moving it to the ISSUE_TEMPLATE/ dir and adding required YAML frontmatter

Details

  • move template and add required YAML frontmatter, per the issue template docs

    • had to figure out this syntax because it's not explicitly documented and the interactive chooser the docs say to use (e.g. https://github.com/agilgur5/rollup-plugin-typescript2/issues/templates/edit) didn't work either...
      • the template chooser doesn't work and throws an error in the console too...:
        Uncaught TypeError: Cannot read properties of null (reading 'content')
            at HTMLDivElement.capture (template-editor.ts:436:33)
        
      • eventually found a section in the issue forms docs that happens to show the syntax for issue template frontmatter
        • but no such example exists in the issue template docs..
  • also add config.yml to disable blank issues

Verification

  • tested against my own fork with a lot of (pretty frustrating) trial-and-error
    • (also had to temporarily enable issues and temporarily disable actions to not waste CI minutes testing this. not an ideal testing format, a branch preview would be very helpful...)

Historical Context

Misc Notes

  • Note that issue forms are still in beta and still don't support custom markdown/HTML on output, so don't support the "spoiler" <details> tag we use to condense various sections
  • GitHub has been breaking things left and right for many months now...

changes:
- and add required YAML frontmatter, as described in https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates#issue-templates
  - had to figure out this syntax because it's not explicitly documented and the interactive chooser the docs say to use (e.g. https://github.com/agilgur5/rollup-plugin-typescript2/issues/templates/edit) didn't work either...
    - the template chooser doesn't work and throws an error in the console too...:
        ```
        Uncaught TypeError: Cannot read properties of null (reading 'content')
            at HTMLDivElement.capture (template-editor.ts:436:33)
        ```
    - eventually found [a section in the issue forms docs](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#converting-a-markdown-issue-template-to-a-yaml-issue-form-template) that happens to show the syntax for issue template frontmatter
      - but no such exmaple exists in the issue template docs..
- add `config.yml` to disable blank issues

verification:
- tested against my own fork with a lot of (pretty frustrating) trial-and-error: https://github.com/agilgur5/rollup-plugin-typescript2/activity?ref=master
  - (also had to temporarily enable issues and temporarily disable actions to not waste CI minutes testing this. not an ideal testing format, a branch preview would be very helpful...)

history:
- the `.github/issue_template.md` single template was apparently silently removed by GitHub:
  - github/docs@21f56d5 has some docs removals
    - the [GHE release note](https://github.com/github/docs/blob/21f56d5cea553bfce069b343f19b4039ed5bee69/data/release-notes/enterprise-server/3-18/0.yml#L258) therein explicitly says it is no longer supported (but no announcement for GitHub.com?)
  - from our own issues, it appears to have been removed at some point between March 30th and May 3rd 2026
    - it had been working at least since March 26th (later issue was edited to use the template, so unsure if it saw the prompt or not)
  - it was reported to GitHub Docs on May 17th and removed from the docs on the 21st via github/docs@9e08905
    - that was apparently originally reported to Nix in NixOS/nixpkgs@556e57a
    - Note that the word "deprecate" in these instances is incorrect -- it was entirely removed, with no deprecation nor deprecation warning

notes:
- Note that issue _forms_ are still in beta and still don't support custom markdown/HTML on output, so don't support the "spoiler" `<details>` tag to condense various sections
@agilgur5 agilgur5 added kind: bug Something isn't working properly kind: regression Specific type of bug -- past behavior that worked is now broken scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI) scope: upstream Issue in upstream dependency labels Jul 22, 2026
@agilgur5
agilgur5 requested a review from ezolenko July 22, 2026 15:23
@ezolenko
ezolenko merged commit 4cff90b into ezolenko:master Jul 23, 2026
6 checks passed
@agilgur5
agilgur5 deleted the fix-gh-issue-template branch July 23, 2026 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind: bug Something isn't working properly kind: regression Specific type of bug -- past behavior that worked is now broken scope: github GH-only changes, e.g. issue and PR templates, releases, etc (not docs or CI) scope: upstream Issue in upstream dependency

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants