93 use submodule for shared assets

.dockerignore

@@ -10,3 +10,5 @@ docker-compose.yml
 README.md
 LICENSE.txt
 public/cache
+app/Assets/frontpage-assets/.git
+app/Assets/frontpage-assets/files

.github/workflows/ci.yml

@@ -11,6 +11,8 @@ jobs:
       COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Build services
         run: docker compose build
@@ -34,6 +36,8 @@ jobs:
       COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Build services
         run: docker compose build
@@ -57,6 +61,8 @@ jobs:
       COMPOSE_PROJECT_NAME: ci-${{ github.job }}-${{ github.run_id }}
     steps:
       - uses: actions/checkout@v4
+        with:
+          submodules: true
 
       - name: Build services
         run: docker compose build

.github/workflows/publish.yml

@@ -14,6 +14,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: ${{ github.sha }}
+          submodules: true
 
       - uses: docker/setup-buildx-action@v3
 

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "app/Assets/frontpage-assets"]
+	path = app/Assets/frontpage-assets
+	url = https://github.com/uklibraries/exploreuk-frontpage-assets

Dockerfile

@@ -101,6 +101,9 @@ COPY ./app ./app
 COPY ./public ./public
 COPY ./exe ./exe
 
+RUN test -f public/shared/images/imls.png || \
+    (echo "exploreuk-frontpage-assets submodule missing; check out with submodules" && exit 1)
+
 COPY entrypoint.sh /usr/local/bin/entrypoint.sh
 RUN chmod +x /usr/local/bin/entrypoint.sh
 

README.md

@@ -19,12 +19,20 @@ Developer installations have been tested on Linux (through Windows with
 ### Quickstart
 
 ```shell
-git clone https://github.com/uklibraries/findingaid.git
+git clone --recurse-submodules https://github.com/uklibraries/findingaid.git
 cd findingaid
 make sample
 make dev
 ```
 
+Images shared between findingaid and
+[exploreuk-web-app](https://github.com/uklibraries/exploreuk-web-app) come
+from the
+[exploreuk-frontpage-assets](https://github.com/uklibraries/exploreuk-frontpage-assets)
+submodule at `app/Assets/frontpage-assets`, served through the `public/shared`
+symlink. If you have cloned without `--recurse-submodules`, run
+`git submodule update --init`.
+
 The application should then be available at `http://localhost:8080/?id=<id>`.
 Developers should run `make help` to see a list of helper commands through
 [make](https://www.gnu.org/software/make/).

app/Views/Euk_Shared/global-footer.mustache

@@ -78,7 +78,7 @@
 
       <div class="editorial">
         <a href="https://libguides.uky.edu/fedgov" title="This library is a Congressionally designated Regional Depository for U.S. Government Publications. Public access to the federal government publications collection is guaranteed by public law.">
-          <img class="uklib-footer-fdlp" src="/assets/images/fdlp-logo.png" alt="Federal Depository Library">
+          <img class="uklib-footer-fdlp" src="shared/images/fdlp-logo.png" alt="Federal Depository Library">
         </a>
       </div>
 

app/Views/Euk_Shared/sponsors.mustache

@@ -8,19 +8,19 @@
         </div>
         <div class="grid grid--5-up sponsor-logo">
             <div class="grid__column">
-                <a href="https://www.imls.gov/"><img id="footer_funder_image" class="lazy sponsor-logo-short" src="/assets/images/middlegray.png" data-src="/assets/images/imls.png" alt="Institute of Museum and Library Services" /></a>
+                <a href="https://www.imls.gov/"><img id="footer_funder_image" class="lazy sponsor-logo-short" src="shared/images/middlegray.png" data-src="shared/images/imls.png" alt="Institute of Museum and Library Services" /></a>
             </div>
             <div class="grid__column">
-                <a href="https://www.clir.org/"><img class="lazy sponsor-logo-short" src="/assets/images/middlegray.png" data-src="/assets/images/clir.svg" alt="Council on Library and Information Resources"/></a>
+                <a href="https://www.clir.org/"><img class="lazy sponsor-logo-short" src="shared/images/middlegray.png" data-src="shared/images/clir.svg" alt="Council on Library and Information Resources"/></a>
             </div>
             <div class="grid__column">
-                <a href="https://www.neh.gov/"><img class="lazy sponsor-logo-short" src="/assets/images/middlegray.png" data-src="/assets/images/neh_preferred_black.png" alt="National Endowment for the Humanities" /></a>
+                <a href="https://www.neh.gov/"><img class="lazy sponsor-logo-short" src="shared/images/middlegray.png" data-src="shared/images/neh_preferred_black.png" alt="National Endowment for the Humanities" /></a>
             </div>
             <div class="grid__column">
-                <a href="https://www.archives.gov/nhprc"><img class="lazy sponsor-logo-short" src="/assets/images/middlegray.png" data-src="/assets/images/nhprc-logo.png" alt="National Archives - National Historical Publications and Records Commission"/></a>
+                <a href="https://www.archives.gov/nhprc"><img class="lazy sponsor-logo-short" src="shared/images/middlegray.png" data-src="shared/images/nhprc-logo.png" alt="National Archives - National Historical Publications and Records Commission"/></a>
             </div>
             <div class="grid__column">
-                <a href="https://heyburncollections.org/"><img class="lazy sponsor-logo-short" src="/assets/images/middlegray.png" data-src="/assets/images/heyburn.avif" alt="The John G. Heyburn II Initiative for Excellence in the Federal Judiciary"/></a>
+                <a href="https://heyburncollections.org/"><img class="lazy sponsor-logo-short" src="shared/images/middlegray.png" data-src="shared/images/heyburn.avif" alt="The John G. Heyburn II Initiative for Excellence in the Federal Judiciary"/></a>
             </div>
         </div>
     </div>

public/shared

@@ -0,0 +1 @@
+../app/Assets/frontpage-assets/shared