Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Print friendly error message on bad detected yaml #1578

Conversation

chmouel
Copy link
Member

@chmouel chmouel commented Feb 9, 2024

We now print a more friendly error message when we detect a bad yaml by showing the errors on the git provider interface and the namespace events stream.

support github/bitbucket/gitlab/gitea

this is how it looks like:

image

jira: https://issues.redhat.com/browse/SRVKP-4109

Changes

Submitter Checklist

  • 📝 Please ensure your commit message is clear and informative. For guidance on crafting effective commit messages, refer to the How to write a git commit message guide. We prefer the commit message to be included in the PR body itself rather than a link to an external website (ie: Jira ticket).

  • ♽ Before submitting a PR, run make test lint to avoid unnecessary CI processing. For an even more efficient workflow, consider installing pre-commit and running pre-commit install in the root of this repository.

  • ✨ We use linters to maintain clean and consistent code. Please ensure you've run make lint before submitting a PR. Some linters offer a --fix mode, which can be executed with the command make fix-linters (ensure markdownlint and golangci-lint tools are installed first).

  • 📖 If you're introducing a user-facing feature or changing existing behavior, please ensure it's properly documented.

  • 🧪 While 100% coverage isn't a requirement, we encourage unit tests for any code changes where possible.

  • 🎁 If feasible, please check if an end-to-end test can be added. See README for more details.

  • 🔎 If there's any flakiness in the CI tests, don't necessarily ignore it. It's better to address the issue before merging, or provide a valid reason to bypass it if fixing isn't possible (e.g., token rate limitations).

Copy link

codecov bot commented Feb 9, 2024

Codecov Report

Attention: 38 lines in your changes are missing coverage. Please review.

Comparison is base (4bdfa0f) 63.24% compared to head (53a3c18) 63.78%.
Report is 10 commits behind head on main.

Files Patch % Lines
pkg/pipelineascode/match.go 0.00% 6 Missing and 1 partial ⚠️
pkg/provider/gitea/gitea.go 53.33% 6 Missing and 1 partial ⚠️
pkg/provider/gitea/parse_payload.go 0.00% 4 Missing ⚠️
pkg/cmd/tknpac/describe/describe.go 0.00% 3 Missing ⚠️
pkg/opscomments/comments.go 96.87% 2 Missing and 1 partial ⚠️
pkg/cmd/tknpac/bootstrap/bootstrap.go 0.00% 2 Missing ⚠️
pkg/cmd/tknpac/list/list.go 0.00% 2 Missing ⚠️
pkg/cmd/tknpac/webhook/update-token.go 0.00% 2 Missing ⚠️
pkg/adapter/adapter.go 0.00% 1 Missing ⚠️
pkg/cmd/tknpac/create/repository.go 0.00% 1 Missing ⚠️
... and 6 more
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1578      +/-   ##
==========================================
+ Coverage   63.24%   63.78%   +0.53%     
==========================================
  Files         139      140       +1     
  Lines       10778    10876      +98     
==========================================
+ Hits         6817     6937     +120     
+ Misses       3436     3409      -27     
- Partials      525      530       +5     

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

@chmouel chmouel force-pushed the print-friendly-error-message-on-bad-detected-yaml branch 2 times, most recently from 8a8a00d to 5ecf433 Compare February 12, 2024 16:19
@piyush-garg
Copy link
Member

lgtm

@chmouel chmouel force-pushed the print-friendly-error-message-on-bad-detected-yaml branch from 5ecf433 to 9a88078 Compare February 13, 2024 09:39
@chmouel
Copy link
Member Author

chmouel commented Feb 13, 2024

Thanks @piyush-garg

I have addedd a e2e test on ghe (since it's provider specific) in my latest push and reworded the resolver documentation along the way...

diff of the changes https://github.com/openshift-pipelines/pipelines-as-code/compare/5ecf43355fcabad5e2666eeae490073163bd7bb0..53a3c18eb4757e3d1cc78a07c852246bac9b7196

We now print a more friendly error message when we detect a bad yaml by
showing the errors on the git provider interface and the namespace
events stream.

Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
@chmouel chmouel force-pushed the print-friendly-error-message-on-bad-detected-yaml branch from 16823e4 to 53a3c18 Compare February 13, 2024 10:01
@savitaashture
Copy link
Member

/lgtm

@savitaashture savitaashture merged commit 614d271 into openshift-pipelines:main Feb 13, 2024
6 checks passed
@chmouel chmouel deleted the print-friendly-error-message-on-bad-detected-yaml branch March 5, 2024 16:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants