[Git][ghc/ghc][wip/T24651] Fix documentation preview from doc-tarball job

[Teo Camarasu (@teo)]

Teo Camarasu pushed to branch wip/T24651 at Glasgow Haskell Compiler / GHC


Commits:
b42b2e2a by Teo Camarasu at 2024-04-15T15:00:29+01:00
Fix documentation preview from doc-tarball job

- Include all the .html files and assets in the job artefacts
- Include all the .pdf files in the job artefacts
- Mark the artefact as an "exposed" artefact meaning it turns up in the
  UI.
- Fix GHC API URL in index.html. It was missing the "-inplace" suffix.

Resolves #24651

- - - - -


3 changed files:

- .gitlab-ci.yml
- distrib/mkDocs/mkDocs
- docs/index.html.in


Changes:

=====================================
.gitlab-ci.yml
=====================================
@@ -557,12 +557,17 @@ doc-tarball:
     LINUX_BINDIST: "ghc-x86_64-linux-deb10.tar.xz"
     WINDOWS_BINDIST: "ghc-x86_64-windows.tar.xz"
   artifacts:
+    expose_as: "Documentation Preview"
     paths:
       - haddock.html.tar.xz
+      - docs/haddock/
       - libraries.html.tar.xz
+      - docs/libraries/
       - users_guide.html.tar.xz
-      - index.html
-      - "*.pdf"
+      - docs/users_guide/
+      - docs/index.html
+      - Haddock.pdf
+      - users_guide.pdf
   script:
     - |
       mv "ghc-x86_64-linux-deb10-numa-slow-validate.tar.xz" "$LINUX_BINDIST" \
@@ -582,8 +587,8 @@ doc-tarball:
       fi
     - rm -Rf docs
     - bash -ex distrib/mkDocs/mkDocs $LINUX_BINDIST $WINDOWS_BINDIST
+    - mv docs/*.tar.xz docs/*.pdf .
     - ls -lh
-    - mv docs/*.tar.xz docs/index.html .
 
 hackage-doc-tarball:
   stage: packaging


=====================================
distrib/mkDocs/mkDocs
=====================================
@@ -43,7 +43,7 @@ do
     dir=${i%*/}
     tar -Jcf ../../../../../$dir.html.tar.xz $dir
 done
-mv index.html ../../../../..
+mv index.html users_guide libraries ../../../../..
 cd ..
 mv ./*.pdf ../../../.. || \
     die "failed to find PDFs"


=====================================
docs/index.html.in
=====================================
@@ -39,7 +39,7 @@
 
       <LI>
         <P>
-          <B><A HREF="libraries/ghc- at LIBRARY_ghc_VERSION@/index.html">GHC API</A></B>
+          <B><A HREF="libraries/ghc- at LIBRARY_ghc_VERSION@-inplace/index.html">GHC API</A></B>
         </P>
         <P>
           Documentation for the GHC API.



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/b42b2e2a0439fd85e9eeff9a219b5841ccb0afac

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/b42b2e2a0439fd85e9eeff9a219b5841ccb0afac
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20240415/6274e85f/attachment-0001.html>