Improve template error reporting #23396
Merged
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
zeripath
added
topic/deployment
type/miscellaneous
outdated/backport/v1.19
|
I've marked this as backport because it's precisely the kind of feature that is helpful to be backported. |
GiteaBot
added
the
lgtm/need 2
There are multiple duplicate reports of errors during template rendering due to broken custom templates. Unfortunately the error returned here is somewhat difficult for users to understand and it doesn't return the context of the error. This PR attempts to parse the error returned by the template renderer to add in some further context including the filename of the template AND the preceding lines within that template file. Ref go-gitea#23274 Signed-off-by: Andrew Thornton <art27@cantab.net>
zeripath
force-pushed
the
add-context-to-template-render-error
branch
from
9e854ed to
3de0cdd
Compare
zeripath
commented
Mar 9, 2023
|
Could this display the root template name or the template dependency path when encountering a template error? |
Signed-off-by: Andrew Thornton <art27@cantab.net>
Signed-off-by: Andrew Thornton <art27@cantab.net>
I can't report the template dependency path but I've at least added the a message to say if the issue is a subtemplate. |
delvh
approved these changes
Mar 16, 2023
GiteaBot
added
lgtm/need 1
lunny
approved these changes
Mar 20, 2023
GiteaBot
added
lgtm/done
lunny
added
reviewed/wait-merge
yardenshoham
added
the
lgtm/done
|
🎺 🤖 |
jolheiser
removed
the
reviewed/wait-merge
GiteaBot
pushed a commit
to GiteaBot/gitea
that referenced
this pull request
Mar 20, 2023
There are multiple duplicate reports of errors during template rendering due to broken custom templates. Unfortunately the error returned here is somewhat difficult for users to understand and it doesn't return the context of the error. This PR attempts to parse the error returned by the template renderer to add in some further context including the filename of the template AND the preceding lines within that template file. Ref go-gitea#23274 --------- Signed-off-by: Andrew Thornton <art27@cantab.net>
jolheiser
pushed a commit
that referenced
this pull request
Mar 20, 2023
Backport #23396 by @zeripath There are multiple duplicate reports of errors during template rendering due to broken custom templates. Unfortunately the error returned here is somewhat difficult for users to understand and it doesn't return the context of the error. This PR attempts to parse the error returned by the template renderer to add in some further context including the filename of the template AND the preceding lines within that template file. Ref #23274 Signed-off-by: Andrew Thornton <art27@cantab.net> Co-authored-by: zeripath <art27@cantab.net>
zjjhot
added a commit
to zjjhot/gitea
that referenced
this pull request
Mar 21, 2023
* upstream/main: Replace a few fontawesome icons with svg (go-gitea#23602) Fix pagination on `/notifications/watching` (go-gitea#23564) Fix `.locale.Tr` function not found in delete modal (go-gitea#23468) fix submodule is nil panic (go-gitea#23588) `Publish Review` buttons should indicate why they are disabled (go-gitea#23598) Improve template error reporting (go-gitea#23396) Polyfill the window.customElements (go-gitea#23592) Add CHANGELOG for 1.19.0 (go-gitea#23583)
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.
There are multiple duplicate reports of errors during template rendering due to broken custom templates.
Unfortunately the error returned here is somewhat difficult for users to understand and it doesn't return the context of the error.
This PR attempts to parse the error returned by the template renderer to add in some further context including the filename of the template AND the preceding lines within that template file.
Ref #23274