Skip to content

Commit ad70d59

Browse files
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.
2 parents 5c41152 + 0edf304 commit ad70d59

File tree

18 files changed

+84
-3
lines changed

18 files changed

+84
-3
lines changed

ogma-cli/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Revision history for ogma-cli
22

3-
## [1.X.Y] - 2024-12-23
3+
## [1.X.Y] - 2024-12-24
44

55
* Update contribution guidelines (#161).
66
* Provide ability to customize template in fprime command (#185).
77
* Provide ability to customize template in standalone command (#189).
8+
* Add repository information to cabal package (#148).
89

910
## [1.5.0] - 2024-11-21
1011

ogma-cli/ogma-cli.cabal

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ build-type: Simple
3434
name: ogma-cli
3535
version: 1.5.0
3636
homepage: https://github.com/nasa/ogma
37+
bug-reports: https://github.com/nasa/ogma/issues
3738
license: OtherLicense
3839
license-file: LICENSE.pdf
3940
author: Ivan Perez, Alwyn Goodloe
@@ -116,6 +117,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim
116117
-- exactly what we publish, unmodified by anyone external to our project.
117118
x-curation: uncurated
118119

120+
source-repository head
121+
type: git
122+
location: git@github.com:nasa/ogma.git
123+
subdir: ogma-cli
124+
119125
executable ogma
120126

121127
main-is:

ogma-core/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Revision history for ogma-core
22

3-
## [1.X.Y] - 2024-12-23
3+
## [1.X.Y] - 2024-12-24
44

55
* Replace queueSize with QUEUE_SIZE in FPP file (#186).
66
* Use template expansion system to generate F' monitoring component (#185).
77
* Use template expansion system to generate standalone Copilot monitor (#189).
8+
* Add repository information to cabal package (#148).
89

910
## [1.5.0] - 2024-11-21
1011

ogma-core/ogma-core.cabal

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ build-type: Simple
3434
name: ogma-core
3535
version: 1.5.0
3636
homepage: https://github.com/nasa/ogma
37+
bug-reports: https://github.com/nasa/ogma/issues
3738
license: OtherLicense
3839
license-file: LICENSE.pdf
3940
author: Ivan Perez, Alwyn Goodloe
@@ -84,6 +85,11 @@ data-files: templates/copilot-cfs/CMakeLists.txt
8485
-- exactly what we publish, unmodified by anyone external to our project.
8586
x-curation: uncurated
8687

88+
source-repository head
89+
type: git
90+
location: git@github.com:nasa/ogma.git
91+
subdir: ogma-core
92+
8793
library
8894

8995
exposed-modules:

ogma-extra/CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Revision history for ogma-extra
22

3-
## [1.X.Y] - 2024-12-05
3+
## [1.X.Y] - 2024-12-24
44

55
* Deprecate unnecessary functions (#185).
6+
* Add repository information to cabal package (#148).
67

78
## [1.5.0] - 2024-11-21
89

ogma-extra/ogma-extra.cabal

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ build-type: Simple
3434
name: ogma-extra
3535
version: 1.5.0
3636
homepage: https://github.com/nasa/ogma
37+
bug-reports: https://github.com/nasa/ogma/issues
3738
license: OtherLicense
3839
license-file: LICENSE.pdf
3940
author: Ivan Perez, Alwyn Goodloe
@@ -59,6 +60,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim
5960
-- exactly what we publish, unmodified by anyone external to our project.
6061
x-curation: uncurated
6162

63+
source-repository head
64+
type: git
65+
location: git@github.com:nasa/ogma.git
66+
subdir: ogma-extra
67+
6268
library
6369

6470
exposed-modules:

ogma-language-c/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Revision history for ogma-language-c
22

3+
## [1.X.Y] - 2024-12-24
4+
5+
* Add repository information to cabal package (#148).
6+
37
## [1.5.0] - 2024-11-21
48

59
* Version bump 1.5.0 (#178).

ogma-language-c/ogma-language-c.cabal

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ build-type: Custom
3434
name: ogma-language-c
3535
version: 1.5.0
3636
homepage: https://github.com/nasa/ogma
37+
bug-reports: https://github.com/nasa/ogma/issues
3738
license: OtherLicense
3839
license-file: LICENSE.pdf
3940
author: Ivan Perez, Alwyn Goodloe
@@ -61,6 +62,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim
6162
-- exactly what we publish, unmodified by anyone external to our project.
6263
x-curation: uncurated
6364

65+
source-repository head
66+
type: git
67+
location: git@github.com:nasa/ogma.git
68+
subdir: ogma-language-c
69+
6470
custom-setup
6571
setup-depends:
6672
base >= 4.11.0.0 && < 5

ogma-language-cocospec/CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Revision history for ogma-language-cocospec
22

3+
## [1.X.Y] - 2024-12-24
4+
5+
* Add repository information to cabal package (#148).
6+
37
## [1.5.0] - 2024-11-21
48

59
* Version bump 1.5.0 (#178).

ogma-language-cocospec/ogma-language-cocospec.cabal

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ build-type: Custom
3434
name: ogma-language-cocospec
3535
version: 1.5.0
3636
homepage: https://github.com/nasa/ogma
37+
bug-reports: https://github.com/nasa/ogma/issues
3738
license: OtherLicense
3839
license-file: LICENSE.pdf
3940
author: Ivan Perez, Alwyn Goodloe
@@ -62,6 +63,11 @@ description: Ogma is a tool to facilitate the integration of safe runtim
6263
-- exactly what we publish, unmodified by anyone external to our project.
6364
x-curation: uncurated
6465

66+
source-repository head
67+
type: git
68+
location: git@github.com:nasa/ogma.git
69+
subdir: ogma-language-cocospec
70+
6571
custom-setup
6672
setup-depends:
6773
base >= 4.11.0.0 && < 5

0 commit comments

Comments
 (0)