Add example with GitHub Actions

2 files changed, 46 insertions, 0 deletions

diff --git a/docs/examples.md b/docs/examples.md
index fdf593c..3beba85 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -175,6 +175,25 @@ The following scripts can also be found in the
 ```
 :::
 
+### Using with GitHub Actions
+This example shows how to use requests-cache with [GitHub Actions](https://docs.github.com/en/actions).
+Key points:
+* Create the cache file within the CI project directory
+* You can use [actions/cache](https://github.com/actions/cache) to persist the cache file across
+  workflow runs
+    * You can use a constant cache key within this action to let requests-cache handle expiration
+
+
+:::{dropdown} Example
+:animate: fade-in-slide-down
+:color: primary
+:icon: file-code
+
+[github_actions.yml](https://github.com/requests-cache/requests-cache/blob/main/examples/github_actions.yml)
+```{literalinclude} ../examples/github_actions.yml
+```
+:::
+
 ### Converting an old cache
 ```{include} ../examples/convert_cache.py
 :start-line: 2
diff --git a/examples/github_actions.yml b/examples/github_actions.yml
new file mode 100644
index 0000000..dffd045
--- /dev/null
+++ b/examples/github_actions.yml
@@ -0,0 +1,27 @@
+name: Test requests-cache with GitHub Actions
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
+      # Persist the SQLite file created by requests-cache across workflow runs
+      - id: cache
+        uses: actions/cache@v3
+        with:
+          path: example_cache.sqlite
+          key: none
+
+      # Install and run basic requests-cache example
+      - run: pip install '.'
+      - run: python examples/basic_sessions.py
+      - run: python examples/basic_sessions.py
+      - run: test -f example_cache.sqlite && echo 'Cache file created' || echo 'Cache file missing'