semantic-prs: Merge queues are not supported

Describe the bug

When adding a PR to a merge queue in a repo where this check is required according to branch protection rules, it hangs with “Waiting for status to be reported”.

I think the fix could be as simple as triggering this check on a pull_request.enqueued event.

Thanks!

semantic.yml contents

# Config ref: https://github.com/Ezard/semantic-prs

# Validate the PR title, and ignore all commit messages
titleOnly: true

# Provides a custom URL for the "Details" link, which appears next to the success/failure message from the app:
targetUrl: https://docs.meltano.com/contribute/merge#semantic-prs

# The values allowed for the "type" part of the PR title/commit message.
# e.g. for a PR title/commit message of "feat: add some stuff", the type would be "feat"
types:
  - ci
  - chore
  - build
  - break
  - change
  - docs
  - feat
  - fix
  - perf
  - refactor
  - revert
  - style
  - test

# The values allowed for the "scope" part of the PR title/commit message.
# e.g. for a PR title/commit message of "feat(awesome-feature): add some stuff",
#      the scope would be "awesome-feature"
scopes:
  - core
  - cli
  - cloud
  - deps
  - deps-dev

Sample PR Title(s) (if relevant)

No response

Sample Commit Message(s) (if relevant)

No response

About this issue

  • Original URL
  • State: closed
  • Created 3 years ago
  • Reactions: 1
  • Comments: 17 (9 by maintainers)

Most upvoted comments

Functionality to support merge queue checks has now been deployed

You’ll need to accept a new permission for the bot in order to enable support for this

Let me know how you get on, and whether you’re still seeing issues (hopefully not though 😄)

Ah, looks like there’s a merge_group.checks_requested event, which I think is the one that we need

Thinking about it though, is there anything that this bot actually needs to do in this instance?

PRs can only be added to a merge queue when their checks pass, and unlike some other checks (e.g. running tests), the fact that a PR is part of a merge queue isn’t going to affect whether or not it’s got semantic naming conventions (since that check is isolated to just the PR itself, and can’t be affected by others)

So I think that in this case, the bot can just report back a successful status to avoid blocking the queue

What do you think?

yes, just report success on merge_group.checks_requested event

@edgarrmondragon apologies, I had to roll back as something with the new version was causing things to time out; I’ll ping again when a solution is found and deployed

@edgarrmondragon @szechyjs FYI this has now been deployed; apologies for the delay!

Thanks for raising this @edgarrmondragon!

Not sure how I can test this myself, so I’ll add that new event in, and then if you could verify that everything is working on your side then that’d be great 🙂