Commit ad70d59
committed
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.File tree
18 files changed
+84
-3
lines changed- ogma-cli
- ogma-core
- ogma-extra
- ogma-language-cocospec
- ogma-language-copilot
- ogma-language-c
- ogma-language-jsonspec
- ogma-language-smv
- ogma-spec
18 files changed
+84
-3
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| |||
116 | 117 | | |
117 | 118 | | |
118 | 119 | | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
119 | 125 | | |
120 | 126 | | |
121 | 127 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| 8 | + | |
8 | 9 | | |
9 | 10 | | |
10 | 11 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| |||
84 | 85 | | |
85 | 86 | | |
86 | 87 | | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
87 | 93 | | |
88 | 94 | | |
89 | 95 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
| 6 | + | |
6 | 7 | | |
7 | 8 | | |
8 | 9 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| |||
59 | 60 | | |
60 | 61 | | |
61 | 62 | | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
62 | 68 | | |
63 | 69 | | |
64 | 70 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
3 | 7 | | |
4 | 8 | | |
5 | 9 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| |||
61 | 62 | | |
62 | 63 | | |
63 | 64 | | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
64 | 70 | | |
65 | 71 | | |
66 | 72 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
3 | 7 | | |
4 | 8 | | |
5 | 9 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
34 | 34 | | |
35 | 35 | | |
36 | 36 | | |
| 37 | + | |
37 | 38 | | |
38 | 39 | | |
39 | 40 | | |
| |||
62 | 63 | | |
63 | 64 | | |
64 | 65 | | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
65 | 71 | | |
66 | 72 | | |
67 | 73 | | |
| |||
0 commit comments