Skip to content

Clarify role of ~/.cabal when determining config file. #10972

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

Merged
merged 1 commit into from
Jun 12, 2025

Conversation

athas
Copy link
Collaborator

@athas athas commented May 30, 2025

This is purely a documentation change that makes the behaviour more explicit.

The actual behaviour is unchanged, although the need for a five step checklist to find the config file suggests that perhaps things have gotten a bit out of hand.

Template B: This PR does not modify behaviour or interface

E.g. the PR only touches documentation or tests, does refactorings, etc.

Include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Is this a PR that fixes CI? If so, it will need to be backported to older cabal release branches (ask maintainers for directions).

@Mikolaj
Copy link
Member

Mikolaj commented May 30, 2025

Python is acting up. Let me restart the failed CI jobs.

@Mikolaj Mikolaj requested a review from Bodigrim May 30, 2025 14:02
Copy link
Member

@Mikolaj Mikolaj left a comment

Choose a reason for hiding this comment

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

Thank you.

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.

Formally speaking, this should close #10713, which was a purely documentation inquiry. But I see an active discussion there, so up to you...

@geekosaur
Copy link
Collaborator

This is explicitly a follow-on to that issue, and is not a final solution as discussion continues about possibly simplifying the behavior.

@ulysses4ever
Copy link
Collaborator

@athas merge label?

@ulysses4ever
Copy link
Collaborator

all right, I'll take the liberty to put the merge label...

@ulysses4ever ulysses4ever added documentation merge me Tell Mergify Bot to merge labels Jun 10, 2025
@mergify mergify bot added the ready and waiting Mergify is waiting out the cooldown period label Jun 10, 2025
@ulysses4ever
Copy link
Collaborator

actually, @Bodigrim, can you take a look first? It was your issue, so it'd be good to have your opinion here.

@ulysses4ever ulysses4ever removed merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period labels Jun 10, 2025
@athas
Copy link
Collaborator Author

athas commented Jun 10, 2025

I don't understand what is expected of me here. I think this should be merged; otherwise I would have made the PR a draft.

@ulysses4ever
Copy link
Collaborator

@athas as per https://github.com/haskell/cabal/blob/master/CONTRIBUTING.md#github-pull-request-conventions the PR author is expected to put one of the merge labels when they feel like the PR should be merged.

@athas athas added the merge me Tell Mergify Bot to merge label Jun 10, 2025
@mergify mergify bot added the ready and waiting Mergify is waiting out the cooldown period label Jun 10, 2025
@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Jun 12, 2025
Copy link
Contributor

mergify bot commented Jun 12, 2025

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated.

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

@ulysses4ever
Copy link
Collaborator

@mergify requeue

Copy link
Contributor

mergify bot commented Jun 12, 2025

requeue

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

Copy link
Contributor

mergify bot commented Jun 12, 2025

This pull request has been removed from the queue for the following reason: pull request branch update failed.

The pull request can't be updated.

You should update or rebase your pull request manually. If you do, this pull request will automatically be requeued once the queue conditions match again.
If you think this was a flaky issue, you can requeue the pull request, without updating it, by posting a @mergifyio requeue comment.

This is purely a documentation change that makes the behaviour more explicit.

The actual behaviour is unchanged, although the need for a five step checklist
to find the config file suggests that perhaps things have gotten a bit out of
hand.
@mergify mergify bot merged commit 4ca7aeb into haskell:master Jun 12, 2025
55 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge ready and waiting Mergify is waiting out the cooldown period
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Is ~/.cabal/config supposed to be used when exists, in the absence of envvars and XDG folder?
5 participants