Cache support

sphinx-notes · Nov 30, 2022 · 119bf7f · 119bf7f
1 parent c560a4a
commit 119bf7f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -67,6 +67,8 @@ Input                   Default        Required     Description
                                                     ``$repository_path`` to pip
                                                     requirements file
 ``sphinx_version``      ``''``         ``false``    Custom version of Sphinx
+``cache``               ``false``      ``false``    Enable cache to speed up
+                                                    documentation building
 ======================= ============== ============ =============================
 
 Examples

diff --git a/action.yml b/action.yml
@@ -30,10 +30,21 @@ inputs:
     description: 'Version of Sphinx'
     required: false
     default: ''
+  cache:
+    description: 'Enable cache to speed up documentation building'
+    required: false
+    default: false
 
 runs:
   using: "composite"
   steps:
+    - uses: actions/cache@v3
+      if: ${{ inputs.cache == 'true' }}
+      with:
+        path: /tmp/sphinxnotes-pages
+        key: sphinxnotes-pages-${{ runner.os }}-${{ github.run_id }} # https://github.com/actions/cache/blob/main/tips-and-workarounds.md#update-a-cache
+        restore-keys: |
+          sphinxnotes-pages-${{ runner.os }}
     - run: ${{ github.action_path }}/main.sh
       shell: bash
       env: