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 to check if the cabal file format is changed by a PR or a release and if the change is guarded by a proper format version check #9902

Open
Mikolaj opened this issue Apr 17, 2024 · 0 comments

Comments

@Mikolaj
Copy link
Member

Mikolaj commented Apr 17, 2024

The goal is to have clear easy instructions in the PR review checklist and a new point in the major-forcing release checklist. It should both describe how to easily determine if file format is modified and how to correctly guard the modification behind a version (and how to create a new version if not yet present).

I wonder if really the best way to check it is by inspecting code, but if so, which files exactly? Is it possible to get a hint by verifying if the hash checksums that are in the code got changed? I couldn't find anything about the hash checksums in the cabal manual nor on the wiki. Is there anything about the file format in our docs? I see the file format is documented in https://cabal.readthedocs.io/en/stable/cabal-projectindex.html and this is auto-generated, so we could reverse-engineer something from that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant