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

fix: improve user feedback #1875

Merged
merged 1 commit into from
Dec 20, 2024
Merged

Conversation

Roming22
Copy link
Contributor

Changes

When PaC is used with other CIs (eg openshift-ci), it can happen that a ok-to-test label managed by the other CI is present. That label may persist after a change, but PaC will report the need for the latest content to be approved. This state is likely to confuse the user.

In order to improve the UX, the required action is now explicitely stated in the message in the UI.

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).

  • If you are adding a provider feature, please fill up the following details which provider this feature supports:

    • GitHub
    • GitHub Webhook
    • Gitea
    • Gitlab
    • Bitbucket Cloud
    • Bitbucket Server/DC

    (make sure to update the documentation accordingly)

Copy link

codecov bot commented Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.74%. Comparing base (9800090) to head (0253490).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1875   +/-   ##
=======================================
  Coverage   65.74%   65.74%           
=======================================
  Files         178      178           
  Lines       13836    13836           
=======================================
  Hits         9097     9097           
  Misses       4124     4124           
  Partials      615      615           

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

When PaC is used with other CIs (eg openshift-ci), it can happen that a
`ok-to-test` label managed by the other CI is present. That label may
persist after a change, but PaC will report the need for the latest
content to be approved. This state is likely to confuse the user.

In order to improve the UX, the required action is now explicitely
stated in the message in the UI.
@chmouel
Copy link
Member

chmouel commented Dec 19, 2024

SGTM but we probably want to have this for gitlab (at least) as well

@Roming22
Copy link
Contributor Author

SGTM but we probably want to have this for gitlab (at least) as well

To be fair, I basically did a search&replace assuming the string would be consistent.

I had a quick look in pkg/provider/gitlab in particular gitlab.go, and did not see anything related to a queued or pending status. I would expect the change in pkg/pipelineascode/match.go to apply to all SCM providers.

Let me know if I incorrectly parsed the code.

@chmouel
Copy link
Member

chmouel commented Dec 20, 2024

yeah i checked the code and it indeend doesn't show a comment on webhook based provided when queued

so we good to merge, tks

@chmouel chmouel merged commit 5899d80 into openshift-pipelines:main Dec 20, 2024
6 checks passed
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.

2 participants