Add caching of pi-gen artifacts

usimd · Feb 26, 2024 · 6b908a2 · 6b908a2
1 parent 5317a05
commit 6b908a2
Show file tree

Hide file tree

Showing 12 changed files with 1,720 additions and 82 deletions.
diff --git a/.github/workflows/integration-test.yml b/.github/workflows/integration-test.yml
@@ -44,7 +44,7 @@ jobs:
         id: build
         with:
           image-name: integration-test
-          stage-list: stage0 stage1 stage2 ./__test__/it-test-stage
+          stage-list: stage0
           verbose-output: true
           enable-noobs: true
           compression: xz
@@ -57,6 +57,7 @@ jobs:
           wpa-essid: foo
           wpa-password: '1234567890'
           timezone: ${{ env.CONFIG_TIMEZONE }}
+          enable-pigen-cache: true
 
       - name: List working directory
         run: tree 

diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -32,6 +32,8 @@ jobs:
           include: |-
             dist/licenses.txt
             dist/index.js
+            dist/pre.js
+            dist/post.js
             README.md
             LICENSE
             action.yml

diff --git a/README.md b/README.md
@@ -77,6 +77,10 @@ tries to make sure the stage is respected and its changes are included in the fi
     # 'image-noobs-path'.
     enable-noobs: false
 
+    # Enables caching of pi-gen work artifacts to GitHub action cache to speed up 
+    # repetitive builds.
+    enable-pigen-cache: false
+
     # Enable SSH access to Pi.
     enable-ssh: 0
 

diff --git a/__test__/pi-gen.test.ts b/__test__/pi-gen.test.ts
@@ -41,6 +41,8 @@ const mockPiGenDependencies = (
   ])
 
   jest.spyOn(fs, 'realpathSync').mockImplementationOnce(p => `/${p.toString()}`)
+
+  jest.spyOn(fs, 'mkdirSync').mockReturnValueOnce('')
 }
 
 describe('PiGen', () => {
@@ -89,6 +91,7 @@ describe('PiGen', () => {
       .spyOn(fs, 'realpathSync')
       .mockReturnValueOnce('/any/stage/path')
       .mockReturnValueOnce('/pi-gen/stage0')
+      .mockReturnValueOnce('/pigen-work')
 
     const piGen = await PiGen.getInstance(piGenDir, {
       stageList: ['/any/stage/path', '/pi-gen/stage0'],
@@ -102,8 +105,9 @@ describe('PiGen', () => {
       expect.objectContaining({
         cwd: piGenDir,
         env: expect.objectContaining({
-          PIGEN_DOCKER_OPTS:
-            '-v /any/stage/path:/any/stage/path -v /pi-gen/stage0:/pi-gen/stage0 -e DEBIAN_FRONTEND=noninteractive'
+          PIGEN_DOCKER_OPTS: expect.stringContaining(
+            '-v /any/stage/path:/any/stage/path -v /pi-gen/stage0:/pi-gen/stage0'
+          )
         })
       })
     )
@@ -112,7 +116,10 @@ describe('PiGen', () => {
   it('passes custom docker opts', async () => {
     const piGenDir = 'pi-gen'
     mockPiGenDependencies()
-    jest.spyOn(fs, 'realpathSync').mockReturnValueOnce('/pi-gen/stage0')
+    jest
+      .spyOn(fs, 'realpathSync')
+      .mockReturnValueOnce('/pi-gen/stage0')
+      .mockReturnValueOnce('/pigen-work')
 
     const piGen = await PiGen.getInstance(piGenDir, {
       stageList: ['/pi-gen/stage0'],
@@ -126,8 +133,9 @@ describe('PiGen', () => {
       expect.objectContaining({
         cwd: piGenDir,
         env: expect.objectContaining({
-          PIGEN_DOCKER_OPTS:
-            '-v /foo:/bar -v /pi-gen/stage0:/pi-gen/stage0 -e DEBIAN_FRONTEND=noninteractive'
+          PIGEN_DOCKER_OPTS: expect.stringContaining(
+            '-v /foo:/bar -v /pi-gen/stage0:/pi-gen/stage0'
+          )
         })
       })
     )
@@ -156,13 +164,13 @@ describe('PiGen', () => {
   })
 
   it('configures NOOBS export for stages that export images', async () => {
+    const stageList = [tmp.dirSync().name, tmp.dirSync().name]
+    fs.writeFileSync(`${stageList[0]}/EXPORT_IMAGE`, '')
+
     const piGenDir = 'pi-gen'
     mockPiGenDependencies()
     jest.spyOn(fs, 'realpathSync').mockReturnValueOnce('/pi-gen/stage0')
 
-    const stageList = [tmp.dirSync().name, tmp.dirSync().name]
-    fs.writeFileSync(`${stageList[0]}/EXPORT_IMAGE`, '')
-
     await PiGen.getInstance(piGenDir, {
       stageList: stageList,
       enableNoobs: 'true'

diff --git a/action.yml b/action.yml
@@ -124,6 +124,10 @@ inputs:
       If your custom stage requires additional software or kernel modules to be loaded, add them here. Note that this is not meant to configure modules to be loaded in the target image.
     required: false
     default: ''
+  enable-pigen-cache:
+    description: Enables caching of pi-gen work artifacts to GitHub action cache to speed up repetitive builds.
+    required: false
+    default: false
   pi-gen-dir:
     description: Path where selected pi-gen ref will be checked out to. If the path does not yet exist, it will be created (including its parents).
     required: false
@@ -145,8 +149,9 @@ outputs:
 
 runs:
   using: node20
+  pre: dist/pre.js
   main: dist/index.js
-  post: dist/index.js
+  post: dist/post.js
 
 branding:
   icon: box