Cache demo (#10)

Author: chingc

.github/workflows/cache.yml

@@ -0,0 +1,39 @@
+name: Cache
+
+on:
+  push:
+  schedule:
+    - cron: "0 0 1 * *" # Midnight every month (UTC)
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Cache dates
+        uses: actions/cache@v4
+        with:
+          path: dates.txt
+          key: dates-${{ github.run_id }}-${{ github.run_attempt }}
+          restore-keys: |
+            dates-${{ github.run_id }}-
+            dates-
+
+      - name: Show dates.txt
+        run: |
+          if [[ -f "dates.txt" ]]; then
+            cat dates.txt
+          else
+            touch dates.txt
+          fi
+
+      - name: Add today to top of dates.txt
+        run: |
+          date -u "+%Y-%m-%d %H:%M:%S UTC" > today.txt
+          cat today.txt dates.txt | head -n 5 > new_dates.txt
+          cp new_dates.txt dates.txt
+
+      - name: Show updated dates.txt
+        run: cat dates.txt

README.md

@@ -55,6 +55,19 @@ You may also get an unexpected result depending on the event that triggered the
 
 </details>
 
+## cache.yml
+
+<details>
+
+<summary>Caching data.</summary>
+
+<br/>You can cache files, directories, or a combination of them. If you want to test for a cache hit, keep in mind that it only occurs if it matches the primary cache `key`. A partial match on `restore-keys` is still considered a cache miss.
+
+[cache.yml](.github/workflows/cache.yml)
+- Uses [actions/cache](https://github.com/actions/cache)
+
+</details>
+
 ## context.yml
 
 <details>
@@ -143,14 +156,16 @@ The action also includes an object with the current workflow context, references
 
 ## References
 
-- [GitHub Docs: GitHub Actions](https://docs.github.com/en/actions)
-- [GitHub Docs: Accessing contextual information about workflow runs](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/contexts)
-- [GitHub Docs: Adding a system path](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path)
-- [GitHub Docs: Configuration options for the dependabot.yml file](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)
-- [GitHub Docs: Events that trigger workflows](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows)
-- [GitHub Docs: jobs.<job_id>.outputs](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idoutputs)
-- [GitHub Docs: Setting an environment variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable)
-- [GitHub Docs: Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions)
+- [GitHub Actions](https://docs.github.com/en/actions)
+- [GitHub Actions: Accessing contextual information about workflow runs](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/contexts)
+- [GitHub Actions: Adding a system path](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-system-path)
+- [GitHub Actions: Caching dependencies to speed up workflows](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/caching-dependencies-to-speed-up-workflows)
+- [GitHub Actions: Events that trigger workflows](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows)
+- [GitHub Actions: jobs.<job_id>.outputs](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#jobsjob_idoutputs)
+- [GitHub Actions: Setting an environment variable](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#setting-an-environment-variable)
+- [GitHub Actions: Workflow syntax for GitHub Actions](https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions)
+<br/><br/>
+- [GitHub Docs: Dependabot options reference](https://docs.github.com/en/code-security/dependabot/working-with-dependabot/dependabot-options-reference)
 <br/><br/>
 - [octokit/rest.js API documentation](https://octokit.github.io/rest.js)
 <br/><br/>