How to alert users of known issues with released `cabal-install`?
- Dominant language
- Haskell
- Stars
- 1.7k
- Forks
- 750
- Avg merge
- 4d 3h
- Merged PRs (30d)
- 28
Description
How do we report known issues with released versions of `cabal-install` in a way that end users of `cabal-install` might notice?
From a search of this repo, I found ["known issues"]( https://github.com/search?q=repo%3Ahaskell%2Fcabal+%22known+issues%22&type=code) in the output of the hidden `man` command. That [cabal-install label](https://github.com/haskell/cabal/labels/cabal‐install) has `0 Open` and `0 Closed` issues. Is that the right label?
Up on hackage there's the changelog but what's the best way to alert users of a known issues with packages on hackage short of deprecating the release on hackage, do a revision and amend the changelog or something else?
```
$ cabal man
...
BUGS
To browse the list of known issues or report a new one please see
https://github.com/haskell/cabal/labels/cabal‐install.
...
```
* Amend the changelog: On hackage, the [cabal changelog](https://hackage.haskell.org/package/cabal-install-3.10.3.0/changelog) redirects to this repository's [release-notes](https://github.com/haskell/cabal/tree/master/release-notes) via plain text display of links that are not clickable but these release notes are generated, aren't they? How would we then add a known issue as an addendum?
> [!NOTE]
> \-\*-change-log-*-
>
> 3.10.3.0 Hécate @glitchbra.in> January 2024
> * See https://github.com/haskell/cabal/blob/master/release-notes/cabal-install-3.10.3.0.md
>
> 3.10.2.1 Hécate @glitchbra.in> November 2023
> * See https://github.com/haskell/cabal/blob/master/release-notes/cabal-install-3.10.2.1.md
* Add known issues to the docs: https://cabal.readthedocs.io/en/3.10/ doesn't have a release notes or know issues section. By comparison the GHC users guide does have a [known issues section](https://downloads.haskell.org/~ghc/9.4.5/docs/users_guide/bugs.html) but this wouldn't be updated after a release would it?
Contributor guide
Research direction
Start with the BUGS section generated for the hidden `cabal man` command, the `release-notes` directory, and the cabal-install changelog links shown in the issue. Compare these with the linked GHC known-issues documentation and determine whether the project has a documented, maintainable place and process for post-release notices; done means a decided approach is recorded.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation, release
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100