Refactor issue template parsing and fix API endpoint (#29069) #29140
Conversation
This file contains 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
The old code `GetTemplatesFromDefaultBranch(...) ([]*api.IssueTemplate, map[string]error)` doesn't really follow Golang's habits, then the second returned value might be misused. For example, the API function `GetIssueTemplates` incorrectly checked the second returned value and always responds 500 error. This PR refactors GetTemplatesFromDefaultBranch to ParseTemplatesFromDefaultBranch and clarifies its behavior, and fixes the API endpoint bug, and adds some tests. And by the way, add proper prefix `X-` for the header generated in `checkDeprecatedAuthMethods`, because non-standard HTTP headers should have `X-` prefix, and it is also consistent with the new code in `GetIssueTemplates` # Conflicts: # routers/web/repo/issue.go
GiteaBot
added
the
lgtm/need 2
pull-request-size
bot
added
the
size/L
github-actions
bot
added
the
modifies/api
lunny
approved these changes
Feb 12, 2024
GiteaBot
added
lgtm/need 1
silverwind
approved these changes
Feb 14, 2024
GiteaBot
added
lgtm/done
silverwind
added
the
reviewed/wait-merge
GiteaBot
removed
the
reviewed/wait-merge
|
Automatically locked because of our CONTRIBUTING guidelines |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Backport #29069
The old code
GetTemplatesFromDefaultBranch(...) ([]*api.IssueTemplate, map[string]error)doesn't really follow Golang's habits, then the second returned value might be misused. For example, the API functionGetIssueTemplatesincorrectly checked the second returned value and always responds 500 error.This PR refactors GetTemplatesFromDefaultBranch to ParseTemplatesFromDefaultBranch and clarifies its behavior, and fixes the API endpoint bug, and adds some tests.
And by the way, add proper prefix
X-for the header generated incheckDeprecatedAuthMethods, because non-standard HTTP headers should haveX-prefix, and it is also consistent with the new code inGetIssueTemplates