fix(gh): move issue template to ISSUE_TEMPLATE/ dir - #489
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix the issue template not working by moving it to the
ISSUE_TEMPLATE/dir and adding required YAML frontmatterbuildEndhook #487 (comment)Details
move template and add required YAML frontmatter, per the issue template docs
also add
config.ymlto disable blank issuesVerification
Historical Context
.github/issue_template.mdsingle template was apparently silently removed by GitHub:.github/issue_template.mddoes not work anymore github/docs#44311) and removed from the docs on the 21st via github/docs@9e08905 / deprecate:.github/issue_template.mdblank issues template github/docs#44312Misc Notes
<details>tag we use to condense various sections