applied PackageJanitor

Author: mohamed-barakat

.github/workflows/Tests.yml

@@ -14,6 +14,7 @@ jobs:
     strategy:
       matrix:
         image: [gapsystem/gap-docker, gapsystem/gap-docker-master]
+      fail-fast: false
     runs-on: ubuntu-latest
     container:
       image: ${{ matrix.image }}
@@ -31,10 +32,10 @@ jobs:
           git clone --depth 1 https://github.com/gap-packages/AutoDoc.git
           git clone --depth 1 https://github.com/homalg-project/homalg_project.git
           git clone --depth 1 https://github.com/homalg-project/CAP_project.git
-          git clone --depth 1 https://github.com/homalg-project/CategoryConstructor.git
-          git clone --depth 1 https://github.com/homalg-project/FunctorCategories.git
           git clone --depth 1 https://github.com/homalg-project/HigherHomologicalAlgebra.git
           git clone --depth 1 https://github.com/homalg-project/QPA2.git
+          git clone --depth 1 https://github.com/homalg-project/CategoryConstructor.git
+          git clone --depth 1 https://github.com/homalg-project/FunctorCategories.git
           git clone --depth 1 https://github.com/homalg-project/Toposes.git
           git clone --depth 1 https://github.com/homalg-project/FinSetsForCAP.git
           git clone --depth 1 https://github.com/homalg-project/SubcategoriesForCAP.git
@@ -53,7 +54,7 @@ jobs:
           if [ "${{ matrix.image }}" = "gapsystem/gap-docker" ] && [ "$CUR_SHA" = "$(git rev-parse origin/master)" ] && [ $(dirname "$GITHUB_REPOSITORY") = "homalg-project" ]; then \
             git worktree add gh-pages/ gh-pages || (echo "There was an error. Make sure there is a branch named 'gh-pages'. See https://github.com/homalg-project/PackageJanitor#error-there-was-an-error-make-sure-there-is-a-branch-named-gh-pages"; exit 1); \
             git checkout master; \
-            ./make_dist.sh --token "${{ secrets.GITHUB_TOKEN }}"; \
+            LANG=C.UTF-8 ./make_dist.sh --token "${{ secrets.GITHUB_TOKEN }}"; \
           else \
             echo "Not making a release."; \
           fi

PackageInfo.g

@@ -11,17 +11,17 @@ SetPackageInfo( rec(
 PackageName := "Algebroids",
 Subtitle := "Algebroids and bialgebroids as preadditive categories generated by enhanced quivers",
 Version := Maximum( [
-                   "2020.09.07", ## Mohamed's version
+                   "2020.10-01", ## Mohamed's version
                    ## this line prevents merge conflicts
-                   "2020.09.08", ## Kamal's version
+                   "2020.09-08", ## Kamal's version
                    ## this line prevents merge conflicts
-                   "2019.02.12", ## Florian's version
+                   "2019.02-12", ## Florian's version
                    ## this line prevents merge conflicts
-                   "2019.10.30", ## Sepp's version
+                   "2019.10-30", ## Sepp's version
                    ] ),
 
 Date := ~.Version{[ 1 .. 10 ]},
-Date := Concatenation( ~.Version{[ 9, 10 ]}, "/", ~.Version{[ 6, 7 ]}, "/", ~.Version{[ 1 .. 4 ]} ),
+Date := Concatenation( "01/", ~.Version{[ 6, 7 ]}, "/", ~.Version{[ 1 .. 4 ]} ),
 License := "GPL-2.0-or-later",
 
 Persons := [
@@ -30,11 +30,11 @@ Persons := [
     IsMaintainer := true,
     FirstNames := "Mohamed",
     LastName := "Barakat",
-    WWWHome := "https://mohamed-barakat.github.io",
+    WWWHome := "https://mohamed-barakat.github.io/",
     Email := "mohamed.barakat@uni-siegen.de",
     PostalAddress := Concatenation(
                "Walter-Flex-Str. 3\n",
-               "57072 Siegen\n",
+               "57068 Siegen\n",
                "Germany" ),
     Place := "Siegen",
     Institution := "University of Siegen",
@@ -99,7 +99,7 @@ README_URL      := "https://homalg-project.github.io/Algebroids/README.md",
 ArchiveURL      := Concatenation( "https://github.com/homalg-project/Algebroids/releases/download/v", ~.Version, "/Algebroids-", ~.Version ),
 # END URLS
 
-ArchiveFormats := ".tar.gz",
+ArchiveFormats := ".tar.gz .zip",
 
 ##  Status information. Currently the following cases are recognized:
 ##    "accepted"      for successfully refereed packages

README.md

@@ -1,15 +1,39 @@
 <!-- BEGIN HEADER -->
-# Algebroids – Algebroids and bialgebroids as preadditive categories generated by enhanced quivers
+# Algebroids
 
-| Documentation | Build Status | Code Coverage |
-| ------------- | ------------ | ------------- |
-| [![HTML stable documentation][docs-img]][docs-url] | [![Build Status][tests-img]][tests-url] | [![Code Coverage][codecov-img]][codecov-url] |
+### Algebroids and bialgebroids as preadditive categories generated by enhanced quivers
+
+| Documentation | Latest Release | Build Status | Code Coverage |
+| ------------- | -------------- | ------------ | ------------- |
+| [![HTML stable documentation][html-img]][html-url] [![PDF stable documentation][pdf-img]][pdf-url] | [![version][version-img]][version-url] [![date][date-img]][date-url] | [![Build Status][tests-img]][tests-url] | [![Code Coverage][codecov-img]][codecov-url] |
 
 <!-- END HEADER -->
 
 <!-- BEGIN FOOTER -->
-[docs-img]: https://img.shields.io/badge/HTML-stable-blue.svg
-[docs-url]: https://homalg-project.github.io/Algebroids/doc/chap0_mj.html
+---
+
+### Dependencies
+
+To obtain current versions of all dependencies, `git clone` (or `git pull` to update) the following repositories:
+
+|    | Repository | URL |
+|--- | ---------- | --- |
+| 1. | **homalg_project** | https://github.com/homalg-project/homalg_project |
+| 2. | **CAP_project** | https://github.com/homalg-project/CAP_project |
+| 3. | **HigherHomologicalAlgebra** | https://github.com/homalg-project/HigherHomologicalAlgebra |
+| 4. | **QPA2** | https://github.com/homalg-project/QPA2 |
+
+[html-img]: https://img.shields.io/badge/HTML-stable-blue.svg
+[html-url]: https://homalg-project.github.io/Algebroids/doc/chap0_mj.html
+
+[pdf-img]: https://img.shields.io/badge/PDF-stable-blue.svg
+[pdf-url]: https://homalg-project.github.io/Algebroids/download_pdf.html
+
+[version-img]: https://img.shields.io/endpoint?url=https://homalg-project.github.io/Algebroids/badge_version.json
+[version-url]: https://homalg-project.github.io/Algebroids/view_release.html
+
+[date-img]: https://img.shields.io/endpoint?url=https://homalg-project.github.io/Algebroids/badge_date.json
+[date-url]: https://homalg-project.github.io/Algebroids/view_release.html
 
 [tests-img]: https://github.com/homalg-project/Algebroids/workflows/Tests/badge.svg?branch=master
 [tests-url]: https://github.com/homalg-project/Algebroids/actions?query=workflow%3ATests+branch%3Amaster

makedoc.g

@@ -25,7 +25,7 @@ AutoDoc( rec(
         ),
     ),
     scaffold := rec(
-        entities := [ "homalg", "CAP" ],
+        entities := [ "homalg", "CAP", "QPA" ],
     ),
 ) );
 

makedoc_with_overfull_hbox_warnings.g

@@ -36,7 +36,7 @@ AutoDoc( rec(
         ),
     ),
     scaffold := rec(
-        entities := [ "homalg", "CAP" ],
+        entities := [ "homalg", "CAP", "QPA" ],
     ),
 ) );
 

release-gap-package

@@ -244,6 +244,7 @@ else
     tmp := GAPInfo.PackageInfoCurrent.ArchiveURL;
     Print("GAP_ERROR=\"The ArchiveURL has unexpected value '",tmp,"'\"\n");
 fi;
+Print("PDFFile=\"",GAPInfo.PackageInfoCurrent.PackageDoc.PDFFile,"\"\n");
 EOF
 
 # evaluate the output of GAP, which should be valid shell script code
@@ -407,6 +408,13 @@ git archive --prefix="$BASENAME/" "$TAG" . | tar xf - -C "$TMP_DIR"
 # Build the package documentation, run autoconf, etc.
 cd "$TMP_DIR/$BASENAME"
 
+# adjust date
+# Note that we cannot use sed's `-i` option for in-place editing, as
+# that is a non-portable extension of POSIX, which works differently in
+# BSD and GNU make.
+sed "s;Date := .*;Date := \"$(date +%d/%m/%Y)\",;" PackageInfo.g > PackageInfo.g.bak
+mv PackageInfo.g.bak PackageInfo.g
+
 notice "Removing unnecessary files"
 rm -rf .github .circleci
 rm -f .git* .hg* .cvs*
@@ -451,6 +459,20 @@ fi
 # make sure every file is readable
 chmod -R a+r .
 
+# adjust links to other manuals
+# Note that we cannot use sed's `-i` option for in-place editing, as
+# that is a non-portable extension of POSIX, which works differently in
+# BSD and GNU make.
+for f in ./*/*.htm* ; do
+  sed 's;href="/home/gap/.gap/pkg/homalg_project/Modules/doc/;href="https://homalg-project.github.io/homalg_project/Modules/doc/;g' "$f" > "$f.bak"
+  mv "$f.bak" "$f"
+done
+
+for f in ./*/*.htm* ; do
+  sed 's;href="/home/gap/.gap/pkg/homalg_project/homalg/doc/;href="https://homalg-project.github.io/homalg_project/homalg/doc/;g' "$f" > "$f.bak"
+  mv "$f.bak" "$f"
+done
+
 # basic sanity check
 fgrep -q -r '<a href="/' */*.htm* &&
     error "HTML manual contains absolute paths"
@@ -593,6 +615,26 @@ for EXT in $ARCHIVE_FORMATS ; do
 done
 
 
+######################################################################
+#
+# Upload PDF
+#
+cd "$TMP_DIR"
+echo ""
+
+FULLNAME="$TMP_DIR/$BASENAME/$PDFFile"
+if [ ! -f "$FULLNAME" ] ; then
+	error "could not find PDF"
+fi
+notice "Uploading PDF"
+response=$(curl --fail --progress-bar -o "$TMP_DIR/upload.log" \
+	-X POST "$UPLOAD_URL/$RELEASE_ID/assets?name=$BASENAME.pdf" \
+	-H "Accept: application/vnd.github.v3+json" \
+	-H "Authorization: token $TOKEN" \
+	-H "Content-Type: application/pdf" \
+	--data-binary @"$FULLNAME")
+
+
 ######################################################################
 #
 # Update the website