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

Document how we obtain the name of the cabal config file. #63

Merged
merged 1 commit into from Jan 18, 2024

Conversation

andreasabel
Copy link
Member

@andreasabel andreasabel commented Jan 13, 2024

This adds a comment how we compute the name of the cabal configuration file from the output of cabal --help.

Inherently brittle, so we ensure its correctness upstream:

andreasabel added a commit to haskell/cabal that referenced this pull request Jan 13, 2024
Ensure that the last line of the help text is the name of the config file.
This invariant is used by clients such as the Haskell setup github action.

See: haskell-actions/setup#63
Mikolaj pushed a commit to haskell/cabal that referenced this pull request Jan 17, 2024
Ensure that the last line of the help text is the name of the config file.
This invariant is used by clients such as the Haskell setup github action.

See: haskell-actions/setup#63
@andreasabel andreasabel merged commit 60757a8 into main Jan 18, 2024
41 of 45 checks passed
@andreasabel andreasabel deleted the doc-cabal-config-file branch January 18, 2024 20:29
@andreasabel
Copy link
Member Author

See:

The last line of the help text is not the config file, if it does not exist, but rather:

This file will be generated with sensible defaults if you run 'cabal update'.

We should make the extraction of the cabal config file more robust.

erikd pushed a commit to erikd/cabal that referenced this pull request Apr 22, 2024
Ensure that the last line of the help text is the name of the config file.
This invariant is used by clients such as the Haskell setup github action.

See: haskell-actions/setup#63
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant