Cabal packages do not include repo information

[ivanperez-keera]

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]

Change Manager: Confirmed that the issue exists.

[ivanperez-keera]

Technical Lead: Confirmed that the issue should be addressed.

[ivanperez-keera]

Technical Lead: Issue scheduled for fixing in Ogma 1.6.0.

Fix assigned to: @ivanperez-keera .

[ivanperez-keera]

Implementor: Solution implemented, review requested.

[ivanperez-keera]

Change Manager: Verified that:

• Solution is implemented:
  • The code proposed compiles and passes all tests. Details:
    • Build logs:
      • https://github.com/nasa/ogma/actions/runs/12484682644/job/34842411131
      • https://github.com/nasa/ogma/actions/runs/12484682646/job/34842411113
    • Build log archives:
      • logs_32418275048.zip
      • logs_32418275059.zip
  • The solution proposed produces the expected result. Details:
    The following dockerfile checks that there are no files that do not contain a bug-reports field, or source-repository section, after which it prints the message success:

    FROM ubuntu:focal
    
    RUN apt-get update
    
    RUN apt-get install --yes git
    
    SHELL ["/bin/bash", "-c"]
    CMD git clone $REPO \
        && cd $NAME \
        && git checkout $COMMIT \
        && ! grep -Lre 'bug-reports' --include='*.cabal' ogma**/ \
        && ! grep -Lre 'source-repository' --include='*.cabal' ogma**/ \
        && echo "Success"

    Command (substitute variables based on new path after merge):

    $ docker run -e "REPO=https://github.com/ivanperez-keera/ogma" -e "NAME=ogma" -e "PAT=ogma"  -e "COMMIT=0edf304ad690c2f60fdc6309409dfa5c8f19fd79" -it ogma-verify-148
    

• Implementation is documented. Details:
  No updates needed.
• Change history is clear.
• Commit messages are clear.
• Changelogs are updated.
• Examples are updated. Details:
  No updates needed.
• Required version bumps are evaluated. Details:
  No bump needed; change does not affect API or behavior.

[ivanperez-keera]

Change Manager: Implementation ready to be merged.