Implementing issue template GraphQL API call by divyaramanathan · Pull Request #2539 · cli/cli

divyaramanathan · 2020-12-03T03:05:05Z

closes #2361, fixes #875

In this PR, the following changes were made:

Added new IssueTemplate type and necessary API calls
Added the required IssueTemplates query
Attempted to modify 'create.go' to use this API

samcoe · 2020-12-08T20:40:18Z

api/queries_issue.go

 }

+func IssueTemplates(client *Client, repo *Repository) ([]IssueTemplate, error) {
+	type response struct {


We could simplify/shorten this GQL request using the functionality provided by github.com/shurcooL/githubv4 so that the response struct also acts as the query. Many of the queries in api/queries_repo.go use this style. MilestoneByNumber is a short simple one that might be good to copy from.

samcoe · 2020-12-08T20:42:39Z

api/queries_issue.go

+		return nil, err
+	}
+
+	if !resp.Repository.HasIssuesEnabled {


I would say that this check is outside the scope of responsibilities for this function. If this api call is being made then the caller should be responsible for making sure the repository has issue enabled.

samcoe · 2020-12-08T20:46:51Z

pkg/cmd/issue/create/create.go

+			// overwrites previous templateContent
+			var templates []api.IssueTemplate
+			templates, err = api.IssueTemplates(apiClient, repo)
+			templateContent = templates[0].Body
+			if err != nil {
+				return
+			}


From the discussion in the issue I think this API call should replace the call to prShared.FindTemplates on line 108.

I am going to cc @mislav since it was his his comment about using the API both when -R is provided and when it is not which makes me think that is the desired approach.

Thanks @samcoe for the initial review! You are right that this call needs to happen earlier.

@divyaramanathan You will want to invoke the new API logic just before TemplateSurvey(), since that is where the user will be presented with a list of templates to choose between. Also, since the new API approach replaces looking up templates from the filesystem, you can remove the old filesystem lookups from this file.

samcoe · 2020-12-08T20:48:44Z

This is great progress so far. The API code looks good, just need to hook up the API response to the survey code properly.

mislav

@divyaramanathan Thanks so much for taking this on! I'm really looking forward to improving templates this way.

mislav · 2020-12-09T13:51:06Z

pkg/cmd/issue/create/create.go

+			// overwrites previous templateContent
+			var templates []api.IssueTemplate
+			templates, err = api.IssueTemplates(apiClient, repo)
+			templateContent = templates[0].Body
+			if err != nil {
+				return
+			}


Thanks @samcoe for the initial review! You are right that this call needs to happen earlier.

@divyaramanathan You will want to invoke the new API logic just before TemplateSurvey(), since that is where the user will be presented with a list of templates to choose between. Also, since the new API approach replaces looking up templates from the filesystem, you can remove the old filesystem lookups from this file.

zaboyle · 2020-12-11T03:49:37Z

@mislav @samcoe thanks so much for your awesome feedback!! @divyaramanathan and I made some changes to reflect this behavior:

addressed 2 suggestions from @samcoe to shorten/simplify GQL call
removed references to old filesystem lookups for issue templates
modified TemplateSurvey and selectTemplate logic to work with new IssueTemplate objects

We're still having some issues, mainly:

the template titles aren't displaying properly in the terminal
it seems only 1 template is getting returned from our API call

We did, however, manage to grab this template and edit its contents:

We think we're very very close, and would love some help on how to debug this API call and terminal rendering (we tried Postman but need an auth key). Thanks so much!!

vilmibm · 2021-01-20T18:36:02Z

@mislav to get tests working and add conditional for older enterprise versions

Co-authored-by: Zach Boyle <zboyle@umich.edu>

stale

mislav · 2021-02-10T17:32:19Z

I have updated this branch to have both issue create and pr create work with the new templates approach:

If issue templates API is available (e.g. on github.com and recent GHE versions), read the templates from API instead of from disk. This fixes issue create -R <repo> use, as well as having templates always working regardless of the current branch being checked out.
When an issue template was selected and the issue templates API is available, include the issueTemplate parameter in the final issue payload to enable template labels/assignees/projects to be applied. Fixes Creating an issue from a template doesn't apply template labels to newly created issue #875
- ⚠️ Known issue: when "Continue in browser" was used, the selected template will not apply appropriate labels/assignees/projects. This is because the web interface requires a template filename for its ?template=... query param, whereas the API only provides us with the template name.
Fall back to reading templates from disk when the API isn't available.
"Legacy" GitHub templates are still being read from disk as before and applied if no regular template was found or selected, provided that -R wasn't used.

@divyaramanathan @zaboyle Thank you so much for getting started on this implementation! 🙏

samcoe · 2021-02-10T19:49:44Z

pkg/cmd/issue/create/create.go

+
+				if template != nil {
+					templateContent = string(template.Body())
+					if ok, _ := tpl.HasAPI(); ok {


Exposing HasAPI() seems a bit odd and feels like details only the template manager should be aware of. What if, when doing the fetch of the templates, we don't set the template name if !HasAPI() that way we can just call template.Name() here.

samcoe · 2021-02-10T19:57:02Z

pkg/cmd/pr/shared/templates.go

@@ -0,0 +1,252 @@
+package shared


I really like this direction. I think it would be good to add some unit tests to test these new functions directly since the top level command tests don't necessarily cover all the cases that are handled here.

samcoe

@mislav Thanks for addressing the feedback. The changes look great. Appreciate your work on this.

divyaramanathan mentioned this pull request Dec 3, 2020

gh issue create -R doesn't show issue templates #2361

Closed

samcoe reviewed Dec 8, 2020

View reviewed changes

mislav previously requested changes Dec 9, 2020

View reviewed changes

vilmibm self-requested a review December 18, 2020 22:11

vilmibm assigned mislav Jan 20, 2021

divyaramanathan and others added 3 commits February 8, 2021 22:02

implementing issue template GraphQL API call

c7eb738

Co-authored-by: Zach Boyle <zboyle@umich.edu>

Port issue create to using templates API

3ddd937

Port pr create to new templates implementation

83bb1bf

mislav force-pushed the issue-create-template branch from 1a5801a to 83bb1bf Compare February 10, 2021 17:23

mislav requested a review from samcoe February 10, 2021 17:24

mislav changed the title ~~[WIP] #2361 Implementing issue template GraphQL API call~~ Implementing issue template GraphQL API call Feb 10, 2021

samcoe reviewed Feb 10, 2021

View reviewed changes

cli blocked Ala619 Feb 15, 2021

mislav added 2 commits February 17, 2021 17:08

Un-export HasAPI leaky abstraction

0cd5744

Add tests for templateManager

3a0a8c4

samcoe approved these changes Feb 17, 2021

View reviewed changes

mislav merged commit 3b117e6 into cli:trunk Feb 17, 2021

sushichan044 mentioned this pull request Aug 19, 2025

[GitHub] Use GitHub issue templates raycast/extensions#20059

Closed

Conversation

divyaramanathan commented Dec 3, 2020 • edited by mislav Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samcoe Dec 8, 2020

Choose a reason for hiding this comment

Uh oh!

samcoe Dec 8, 2020

Choose a reason for hiding this comment

Uh oh!

samcoe Dec 8, 2020

Choose a reason for hiding this comment

Uh oh!

mislav Dec 9, 2020

Choose a reason for hiding this comment

Uh oh!

samcoe commented Dec 8, 2020

Uh oh!

mislav left a comment

Choose a reason for hiding this comment

Uh oh!

mislav Dec 9, 2020

Choose a reason for hiding this comment

Uh oh!

zaboyle commented Dec 11, 2020

Uh oh!

vilmibm commented Jan 20, 2021

Uh oh!

mislav commented Feb 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samcoe Feb 10, 2021

Choose a reason for hiding this comment

Uh oh!

samcoe Feb 10, 2021

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

samcoe left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

divyaramanathan commented Dec 3, 2020 •

edited by mislav

Loading

mislav commented Feb 10, 2021 •

edited

Loading