-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop-cabal-repoinfo' into develop. Close #148.
**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. Running 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": ```Dockerfile 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): ```sh $ docker run -e "REPO=https://github.com/NASA/ogma" -e "NAME=ogma" -e "PAT=ogma" -e "COMMIT=<HASH>" -it ogma-verify-148 ``` **Solution implemented** Add bug-reports and source-repository entries to all cabal files. **Further notes** None.
- Loading branch information
Showing
18 changed files
with
84 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Simple | |
name: ogma-cli | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -116,6 +117,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-cli | ||
|
||
executable ogma | ||
|
||
main-is: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Simple | |
name: ogma-core | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -84,6 +85,11 @@ data-files: templates/copilot-cfs/CMakeLists.txt | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-core | ||
|
||
library | ||
|
||
exposed-modules: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Simple | |
name: ogma-extra | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -59,6 +60,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-extra | ||
|
||
library | ||
|
||
exposed-modules: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Custom | |
name: ogma-language-c | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -61,6 +62,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-language-c | ||
|
||
custom-setup | ||
setup-depends: | ||
base >= 4.11.0.0 && < 5 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Custom | |
name: ogma-language-cocospec | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -62,6 +63,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-language-cocospec | ||
|
||
custom-setup | ||
setup-depends: | ||
base >= 4.11.0.0 && < 5 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Simple | |
name: ogma-language-copilot | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -58,6 +59,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-language-copilot | ||
|
||
library | ||
|
||
exposed-modules: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Simple | |
name: ogma-language-jsonspec | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -57,6 +58,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-language-jsonspec | ||
|
||
library | ||
|
||
exposed-modules: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Custom | |
name: ogma-language-smv | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -62,6 +63,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-language-smv | ||
|
||
custom-setup | ||
setup-depends: | ||
base >= 4.11.0.0 && < 5 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ build-type: Simple | |
name: ogma-spec | ||
version: 1.5.0 | ||
homepage: https://github.com/nasa/ogma | ||
bug-reports: https://github.com/nasa/ogma/issues | ||
license: OtherLicense | ||
license-file: LICENSE.pdf | ||
author: Ivan Perez, Alwyn Goodloe | ||
|
@@ -57,6 +58,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim | |
-- exactly what we publish, unmodified by anyone external to our project. | ||
x-curation: uncurated | ||
|
||
source-repository head | ||
type: git | ||
location: [email protected]:nasa/ogma.git | ||
subdir: ogma-spec | ||
|
||
library | ||
|
||
exposed-modules: | ||
|