haskell / haskell/cabal

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

Open
#9,902 0 comments 0 reactions 0 assignees View on GitHub
Cabal: file format documentation release
Dominant language
Haskell
Stars
1.7k
Forks
750
Avg merge
4d 3h
Merged PRs (30d)
28

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start with the Cabal file-format documentation at cabal.readthedocs.io and compare it with the repository's format-related code and hash checksums. Identify the exact files or checklist entries that reveal format changes, then document detection, version guarding, and creating a new version in the PR review checklist and major-forcing release checklist.

Written by the indexing model from the issue text.

Assessment

Tech stack
haskell
Domain
documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.