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

Cabal packages do not include repo information #148

Open
ivanperez-keera opened this issue May 23, 2024 · 0 comments
Open

Cabal packages do not include repo information #148

ivanperez-keera opened this issue May 23, 2024 · 0 comments
Labels
CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Bug Admin only: Change request pertaining to error detected

Comments

@ivanperez-keera
Copy link
Member

ivanperez-keera commented May 23, 2024

Description

The cabal packages do not contain pointers to the repo using the specific entry for this in Cabal, neither for the source, nor to file bug reports. Although such information is not strictly speaking necessary, it helps direct users without having to "jump around" to find out where they need to go.

Type

  • Bug: Cabal files are missing useful information.

Additional context

None.

Requester

  • Ivan Perez

Method to check presence of bug

The following script checks whether cabal files contain bug-reports or repo information:

$ grep -Lre '\(bug-reports\|source-repository\)' --include='*.cabal' ogma**/
ogma-cli/ogma-cli.cabal
ogma-core/ogma-core.cabal
ogma-extra/ogma-extra.cabal
ogma-language-c/ogma-language-c.cabal
ogma-language-cocospec/ogma-language-cocospec.cabal
ogma-language-copilot/ogma-language-copilot.cabal
ogma-language-jsonspec/ogma-language-jsonspec.cabal
ogma-language-smv/ogma-language-smv.cabal
ogma-spec/ogma-spec.cabal

The output should be empty, meaning that all files contain such strings.

Expected result

Running the above grep command prints nothing, indicating that no cabal page is missing bug report or repo source information.

Desired result

Running the above grep command prints nothing, indicating that no cabal page is missing bug report or repo source information.

Proposed solution

Add bug-reports and source-repository entries to all cabal files.

Further notes

None.

@ivanperez-keera ivanperez-keera added CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Bug Admin only: Change request pertaining to error detected labels Sep 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CR:Status:Initiated Admin only: Change request that has been initiated CR:Type:Bug Admin only: Change request pertaining to error detected
Projects
None yet
Development

No branches or pull requests

1 participant