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

Improve bad cabal-version error message (backport #9754) #10024

Merged
merged 1 commit into from
May 22, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented May 16, 2024

I took a stab at improving the error message one receives for a bad cabal-version field, per the discussion here.

Example message:

Errors encountered when parsing cabal file ./records.cabal:

records.cabal:0:0: error:
Unsupported cabal format version in cabal-version field: 3.10.
Current cabal-version values are listed at https://cabal.readthedocs.io/en/stable/file-format-changelog.html.

Template Α: This PR modifies cabal behaviour

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Any changes that could be relevant to users have been recorded in the changelog.
  • The documentation has been updated, if necessary.
  • Manual QA notes have been included.
  • Tests have been added. (Ask for help if you don’t know how to write them! Ask for an exemption if tests are too complex for too little coverage!)

This is an automatic backport of pull request #9754 done by [Mergify](https://mergify.com).

@mergify mergify bot mentioned this pull request May 16, 2024
5 tasks
@mergify mergify bot added the backport label May 16, 2024
Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, an UX improvement, but cabal-install is not known for great UX, so we decided it'd be great to sneak in this improvement.

@ulysses4ever ulysses4ever added the merge me Tell Mergify Bot to merge label May 21, 2024
See: #4899

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit b48a620)
@mergify mergify bot merged commit 9ab5faf into 3.12 May 22, 2024
49 checks passed
@mergify mergify bot deleted the mergify/bp/3.12/pr-9754 branch May 22, 2024 00:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport merge me Tell Mergify Bot to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants