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

Add repository information to cabal packages. Refs #148. #192

Merged
merged 18 commits into from
Dec 24, 2024

Conversation

ivanperez-keera
Copy link
Member

Add information regarding where to file bug reports and where to find the source code to all cabal packages, as prescribed in the solution propose for #148.

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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
…sa#148.

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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
…Refs nasa#148.

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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
…efs nasa#148.

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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
…Refs nasa#148.

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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
…asa#148.

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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
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.

This commit adds both the bug-reports link and the source repository
information to the cabal package.
@ivanperez-keera ivanperez-keera changed the title Add bug reports, repo source information to cabal packages. Refs #148. Add repository information to cabal packages. Refs #148. Dec 24, 2024
@ivanperez-keera
Copy link
Member Author

Change Manager: Verified that:

  • Solution is implemented:
    • The code proposed compiles and passes all tests. Details:
    • 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 ivanperez-keera merged commit ad70d59 into nasa:develop Dec 24, 2024
2 checks passed
@ivanperez-keera ivanperez-keera deleted the develop-cabal-repoinfo branch December 24, 2024 19:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant