Mergifyio / Mergifyio/mergify

Show warning if no config was found

Open
#5,072 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
339
Forks
93
PR merge metrics
No merged PRs in 30d

Description

Context

We placed a mergify config at .github/.mergify.yml. This does not match the expected path .github/mergify.yml. Probably happened because we copied the .mergify.yml from the root of the project.

Now we had a config that could not be found, and the Mergify dashboard showed us an example config (I think). This lead to confusion until we understood that this was an example, and that our config could not be found.

Expected Behavior

I suggest adding a warning that no config was found, and that an example i shown instead. Best with a link to the documentation where the expected file location is explained: https://docs.mergify.com/configuration/#file-used

Scrappy example:

Screenshot 2023-02-20 at 13 42 14

Actual Behavior

If no config was found, it shows an example config.

Steps to Reproduce the Problem

  1. Place a config file at .github/.mergify.yml with custom rules
  2. Check the mergify dashboard
  3. You see an example config, but no info that your configuration was not loaded

Specifications

  • Pull Request URL:
  • Mergify Config URL:

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the dashboard path that handles the absence of a Mergify configuration, using the expected .github/mergify.yml and the incorrect .github/.mergify.yml as reproduction cases. Confirm the example-config state, then add a warning with a link to the documented file location; verify that a valid configuration still displays normally.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.