feat(github): add support for github issue templates #3648

kennyg · 2024-06-09T15:04:21Z

adds support for github issue templates. Closes #3567. Tested this by setting up a local project and adding this snippet to the .projenrc.ts

new IssueTemplate(project.github!, {
  templates: {
    'bug-report.md': '<!-- Bug report template content -->',
    'feature-request.yml': '<!-- Feature request template content -->',
  },
});

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

codecov-commenter · 2024-06-09T16:33:17Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.38%. Comparing base (ad20d2c) to head (912ab2a).
Report is 112 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3648      +/-   ##
==========================================
+ Coverage   96.34%   96.38%   +0.03%     
==========================================
  Files         192      195       +3     
  Lines       37696    38200     +504     
  Branches     3524     3571      +47     
==========================================
+ Hits        36320    36819     +499     
- Misses       1376     1381       +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mrgrain · 2024-06-10T19:16:12Z

src/github/issue-template.ts

+    for (const [fileName, content] of Object.entries(options.templates)) {
+      const filePath = path.join(templatePath, fileName);
+      const fileExtension = path.extname(fileName).toLowerCase();
+      switch (fileExtension) {
+        case ".md":
+          new TextFile(project, filePath, {
+            lines: [content],
+            marker: false,
+            committed: true,
+          });
+          break;
+        case ".yml":
+          new YamlFile(project, filePath, {
+            obj: content,
+            marker: false,
+            committed: true,
+          });
+          break;
+        default:
+          throw new Error(`Unsupported file extension: ${fileExtension}`);
+      }
+    }


Let's convert this into a public addTemplate() class method so it can be reused.

sounds good. i've made the change.

src/github/issue-template.ts

mrgrain · 2024-06-10T19:30:04Z

src/github/issue-template.ts

+  constructor(github: GitHub, options: IssueTemplateOptions) {
+    super(github.project);
+    const project = github.project;


We have moved on from this approach. This is the current state of the art:

Suggested change

constructor(github: GitHub, options: IssueTemplateOptions) {

super(github.project);

const project = github.project;

constructor(scope: IScope, options: IssueTemplateOptions) {

super(scope, "<enter_unique_id_here_if_this_is_a_singleton_component>");

const project = this.project;

const github = GitHub.of(project);

if (!github) {

// add warning here. Or hard fail, but it seems like the github component is not actually needed for this

}

also updated this. thanks for the tip.

mrgrain · 2024-06-10T19:31:47Z

test/github/issue-template.test.ts

+    const project = new TestProject();
+    new IssueTemplate(project.github!, {
+      templates: {
+        "feature-request.yml": "<!-- Feature request template content -->",


doesn't a yaml file imply using an object here?

you're right. I updated the tests to reflect that.

src/github/issue-template.ts

mrgrain · 2024-06-18T08:39:32Z

src/github/issue-template.ts

+   *
+   * @throws {Error} If an unsupported file extension is encountered.
+   */
+  public addTemplates(options: IssueTemplateOptions) {


Neither options.configOptions nor options.templatePath are used. This should take the templates directly.

mrgrain · 2024-06-18T08:40:00Z

src/github/issue-template.ts

+      const blankIssues = options.configOptions?.blankIssuesEnabled;
+      const contactLinks = options.configOptions?.contactLinks;
+
+      new YamlFile(project, ".github/config.yml", {


Suggested change

new YamlFile(project, ".github/config.yml", {

new YamlFile(this, ".github/config.yml", {

mrgrain · 2024-06-18T08:40:08Z

src/github/issue-template.ts

+      const fileExtension = path.extname(fileName).toLowerCase();
+      switch (fileExtension) {
+        case ".md":
+          new TextFile(this.project, filePath, {


Suggested change

new TextFile(this.project, filePath, {

new TextFile(this, filePath, {

mrgrain · 2024-06-18T08:40:16Z

src/github/issue-template.ts

+          });
+          break;
+        case ".yml":
+          new YamlFile(this.project, filePath, {


Suggested change

new YamlFile(this.project, filePath, {

new YamlFile(this, filePath, {

mrgrain · 2024-06-18T08:48:44Z

test/github/issue-template.test.ts

+
+    new IssueTemplate(project, {
+      templates: {
+        "feature-request.yml": YAML.stringify(data),


I was more hoping to create an API that can take in objects directly. Having to stringify data just for it to be parsed again seems counter-intuitive.

I'd suggest an enum-like class approach:

IssueTemplate.markdown(markdown: string); IssueTemplate.form(data: IssueFormSchema);

mrgrain

Just need to do something about the API for forms

kennyg marked this pull request as draft June 9, 2024 15:23

kennyg force-pushed the gh-issue-templates branch from 10ce875 to 61026e1 Compare June 9, 2024 16:25

kennyg force-pushed the gh-issue-templates branch from 61026e1 to b488fe0 Compare June 9, 2024 16:35

kennyg marked this pull request as ready for review June 9, 2024 16:36

mrgrain changed the title ~~feat: add support for github issue templates~~ feat(github): add support for github issue templates Jun 10, 2024

mrgrain reviewed Jun 10, 2024

View reviewed changes

src/github/issue-template.ts Outdated Show resolved Hide resolved

mrgrain reviewed Jun 10, 2024

View reviewed changes

src/github/issue-template.ts Outdated Show resolved Hide resolved

mrgrain reviewed Jun 10, 2024

View reviewed changes

kennyg force-pushed the gh-issue-templates branch 2 times, most recently from 8d5c534 to 1686653 Compare June 15, 2024 17:22

mrgrain reviewed Jun 18, 2024

View reviewed changes

src/github/issue-template.ts Outdated Show resolved Hide resolved

mrgrain reviewed Jun 18, 2024

View reviewed changes

mrgrain requested changes Jun 18, 2024

View reviewed changes

kennyg marked this pull request as draft June 18, 2024 21:39

kennyg added 4 commits June 22, 2024 08:37

feat: add support for github issue templates

39e7b97

test: add test for unsupported extension

c3eff17

chore: remove unused config option

aadd42b

chore: remove this.project

912ab2a

kennyg force-pushed the gh-issue-templates branch from 61162b3 to 912ab2a Compare June 22, 2024 12:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(github): add support for github issue templates #3648

feat(github): add support for github issue templates #3648

kennyg commented Jun 9, 2024

codecov-commenter commented Jun 9, 2024 •

edited

Loading

mrgrain Jun 10, 2024

kennyg Jun 16, 2024

mrgrain Jun 10, 2024

kennyg Jun 16, 2024

mrgrain Jun 10, 2024

kennyg Jun 16, 2024

mrgrain Jun 18, 2024

mrgrain Jun 18, 2024

mrgrain Jun 18, 2024

mrgrain Jun 18, 2024

mrgrain Jun 18, 2024

mrgrain left a comment

-  constructor(github: GitHub, options: IssueTemplateOptions) {
-    super(github.project);
-    const project = github.project;
+  constructor(scope: IScope, options: IssueTemplateOptions) {
+    super(scope, "<enter_unique_id_here_if_this_is_a_singleton_component>");
+    const project = this.project;
+    const github = GitHub.of(project);
+    if (!github) {
+      // add warning here. Or hard fail, but it seems like the github component is not actually needed for this
+    }

	new YamlFile(project, ".github/config.yml", {
	new YamlFile(this, ".github/config.yml", {

	new TextFile(this.project, filePath, {
	new TextFile(this, filePath, {

	new YamlFile(this.project, filePath, {
	new YamlFile(this, filePath, {

feat(github): add support for github issue templates #3648

Are you sure you want to change the base?

feat(github): add support for github issue templates #3648

Conversation

kennyg commented Jun 9, 2024

codecov-commenter commented Jun 9, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrgrain left a comment

Choose a reason for hiding this comment

codecov-commenter commented Jun 9, 2024 •

edited

Loading