Enable GitLab CI/CD

Deploys both a native binary to RiscOS/Library and a cross-compiling one to the GitLab runner machine.

Fix issues identified by CI:

• Several header files were missing copyright notices and licence terms: copy these from the corresponding source files.
• Tell GitLab that one source file is yacc format (rouge syntax colour library doesn't know yacc, so select C as next-best fit).

Requires RiscOS/Sources/Lib/OSLib!2 (merged).

.gitlab-ci.yml

+include:
+  - project: 'Support/CI'
+    file: '/defmod.yml'
+
+deploy_to_library:

sources/h/asmhelp

 /*asmhelp.h - output an help file given a module defn*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef asmhelp_H
 #define asmhelp_H
 

sources/h/cheader

 /*cheader.h - output a C or C++ header file given a module defn*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef cheader_H
 #define cheader_H
 

sources/h/chelp

 /*chelp.h - output an chelp file given a module defn*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef chelp_H
 #define chelp_H
 

sources/h/cstrong

+/*cstrong.h - output an cstrong file given a module defn*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef cstrong_H
 #define cstrong_H
 
-/*cstrong.h - output an cstrong file given a module defn*/
-
 #include <stdio.h>
 
 extern os_error *cstrong_output (char *, char *title, char *author,

sources/h/def

 /*def.h - def file parser*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef def_H
 #define def_H
 

sources/h/hdr

 /*hdr.h - output an AAsm header file given a module defn*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef hdr_H
 #define hdr_H
 

sources/h/main

 /*main.h*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef main_H
 #define main_H
 

sources/h/objasm

 /*objasm.h - output an objasm file given a module defn*/
+
+/*OSLib---efficient, type-safe, transparent, extensible,\n"
+   register-safe A P I coverage of RISC O S*/
+/*Copyright © 1994 Jonathan Coxhead*/
+
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef objasm_H
 #define objasm_H
 

support/h/x

+/****************************************************************
+** Title  :   	SupportLib.h.x
+**
+** Purpose:   	RiscOs Exception Handling
+**
+** Copyright:   ©OSLib
+**
+** History:     970926 TV  Strongarm Compatible version
+**
+*****************************************************************/
+/*
+      OSLib is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; either version 1, or (at your option)
+   any later version.
+
+      OSLib is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+      You should have received a copy of the GNU General Public License
+   along with this programme; if not, write to the Free Software
+   Foundation, Inc, 675 Mass Ave, Cambridge, MA 02139, U S A.
+*/
+
 #ifndef x_H
 #define x_H
 
-/* x.h - exception handling header */
-// Revision History:
-//    	      From OSLib
-// 970926 TV  Strongarm Compatible version
-//
-
 #include <stdio.h>
 #include <stdlib.h>
 #include <setjmp.h>

.gitattributes

 **/s/** gitlab-language=armasm linguist-language=armasm linguist-detectable=true
 **/c/** gitlab-language=c linguist-language=c linguist-detectable=true
 **/h/** gitlab-language=c linguist-language=c linguist-detectable=true
+**/y/** gitlab-language=c linguist-language=yacc linguist-detectable=true

.gitlab-ci.yml

+include:
+  - project: 'Support/CI'
+    file: '/defmod.yml'
+
+deploy_to_library:
+  stage: deploy
+  only:
+    refs: [ master ]
+  tags: [ cross ]
+  script:
+    # Depending on whether the pipeline is launched by the merge request or
+    # manually, VersionNum may or may not have been updated. Switch to the
+    # tip of master to ensure consistency.
+    - git checkout origin/master
+    - SOURCETAG=$(git describe --abbrev=8 --tags --always)
+    - BRANCH=Import$(echo $SOURCETAG | sed -e 's/[-._]//g')
+    - 'curl --location --output ~/cache/common/BuildHost.zip -z ~/cache/common/BuildHost.zip "https://gitlab.riscosopen.org/Products/BuildHost/-/jobs/artifacts/master/download?job=latest_package_tree"'
+    - unzip -q ~/cache/common/BuildHost.zip
+    - '[ ! -e BuildInfo ] || cat BuildInfo'
+    - source RiscOS/Env/ROOL/BuildHost.sh
+    - git clone https://$USER:$PASSWORD@gitlab.riscosopen.org/$USER/Library.git
+    - TARGET=!Run INSTDIR=../Library/Build/DefMod mk install
+    # If the installed binary has changed in any way, raise a merge request
+    - cd Library && git diff --quiet --exit-code || ( git checkout -b $BRANCH; git add .; git commit -m "Update defmod from tag $SOURCETAG"; git push -o merge_request.create -o merge_request.target=RiscOS/Library/master origin $BRANCH )
+
+deploy_to_runner:
+  stage: deploy
+  only:
+    refs: [ master ]
+  tags: [ cross ]
+  script:
+    # Depending on whether the pipeline is launched by the merge request or
+    # manually, VersionNum may or may not have been updated. Switch to the
+    # tip of master to ensure consistency.
+    - git checkout origin/master
+    - git clone --recurse-submodules https://gitlab.riscosopen.org/Products/CrossTools.git
+    - rm -rf RiscOS && mv CrossTools/RiscOS .
+    # Assume tools are not 64-bit safe until we determine otherwise
+    - export CFLAGS=-m32
+    - export LDFLAGS=-m32
+    - source RiscOS/Env/ROOL/CrossTools.sh
+    # Build dependency libraries
+    - mk -C RiscOS/Sources/Lib/OSLib export_hdrs
+    - COMPONENT=RISC_OSLib mk -C RiscOS/Sources/Lib/RISC_OSLib export_libs
+    # Build the tool
+    - INSTDIR=.. mk install
+    # Upload binary
+    - chmod 400 $SSH_PRIVATE_KEY
+    - rsync -avc -e "ssh -i $SSH_PRIVATE_KEY" --chown rool:rool --chmod=711 defmod root@localhost:/opt/rool/bin/defmod

[Robert Sprowson]

This merge request doesn't seem to have attracted any love for 6+ months, so I'll dare to look at it.

The defmod code changes in themselves are all nice and bland, but I am going to query the rash of YAML (same goes for RiscOS/Sources/Apps/SquashApp!1 and RiscOS/Tools/Sources/Squish!1 so an opportunity for 3 birds with 1 stone here) that the deploy step looks pretty fragile. By which I mean: it's got lots of magic paths baked into it that I could imagine could be subject to the whims of GitLab in major version bumps, various sideband back scratchery, and other incantations.

So as to avoid having to keep reworking numerous components when the winds change direction, could all that stuff be swept into a single place then merely referenced here? I don't know much about YAML but I'd guess it supports multiple include files so you might end up with

include:
  - project: 'Support/CI'
    file: '/defmod.yml'

deploy:
    file: 'CD/defmod.yml'

And all the scripts then live in Support/CD like the CI scripts live in Support/CI If multiple include files aren't supported then next option would be to have the scripts live in Support/CD and have the refresh.awk notice they exist and append them so you have

include:
  - project: 'Support/CI'
    file: '/defmod.yml'

The power of the shared makefiles and the autogenerated CI scripts allowing 1 change to be made centrally and all the clients inherit that is the pattern I think would work well here.

[Robert Sprowson]

This merge request doesn't seem to have attracted any love for 6+ months, so I'll dare to look at it.

The defmod code changes in themselves are all nice and bland, but I am going to query the rash of YAML (same goes for RiscOS/Sources/Apps/SquashApp!1 and RiscOS/Tools/Sources/Squish!1 so an opportunity for 3 birds with 1 stone here) that the deploy step looks pretty fragile. By which I mean: it's got lots of magic paths baked into it that I could imagine could be subject to the whims of GitLab in major version bumps, various sideband back scratchery, and other incantations.

So as to avoid having to keep reworking numerous components when the winds change direction, could all that stuff be swept into a single place then merely referenced here? I don't know much about YAML but I'd guess it supports multiple include files so you might end up with

include:
  - project: 'Support/CI'
    file: '/defmod.yml'

deploy:
    file: 'CD/defmod.yml'

And all the scripts then live in Support/CD like the CI scripts live in Support/CI If multiple include files aren't supported then next option would be to have the scripts live in Support/CD and have the refresh.awk notice they exist and append them so you have

include:
  - project: 'Support/CI'
    file: '/defmod.yml'

The power of the shared makefiles and the autogenerated CI scripts allowing 1 change to be made centrally and all the clients inherit that is the pattern I think would work well here.