alif-digest 1.1.2 → 1.1.4

package/README.md

@@ -158,21 +158,28 @@ Config is stored at `~/.config/alif/config.json`. Most values can be changed wit
 
 ## ☁️ Running on GitHub Actions (Free)
 
-You can run Alif entirely in the cloud for free using GitHub Actions, without ever installing it locally.
-
-1. **Fork this repository.**
-2. Navigate to your fork's **Settings > Secrets and variables > Actions**.
-3. Add your sensitive API keys as **Repository Secrets**:
-   - `ALIF_LLM_API_KEY` (or `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`)
-   - `SLACK_WEBHOOK_URL` (or `GENERIC_WEBHOOK_URL`)
-4. Configure your preferences as **Repository Variables** (optional):
-   - `ALIF_LLM_PROVIDER` (default: anthropic)
-   - `ALIF_LLM_MODEL`
-   - `ALIF_SIGNAL_THRESHOLD` (default: 60)
-   - `ALIF_MAX_ITEMS_PER_RUN` (default: 10)
-   - `ALIF_SOURCE_COOLDOWN_MINUTES` (default: 5)
-
-The included workflow (`.github/workflows/alif-scheduled-run.yml`) automatically runs every day at 8:00 AM UTC (feel free to change the schedule in your forked version), caches your database/state, and delivers your customized digest!
+To ensure your API keys and workflow logs remain completely secure and hidden from the public, we highly recommend running this in a **Private** GitHub repository.
+
+1. **Create a new Private Repository** on GitHub.
+2. **Copy the example workflow:** Copy the [`examples/alif-scheduled-run.yml`](./examples/alif-scheduled-run.yml) file into your new private repository at `.github/workflows/alif-scheduled-run.yml`.
+3. Navigate to your private repository's **Settings > Secrets and variables > Actions**.
+4. Add your sensitive access credentials as **Repository Secrets**.
+5. Configure your preferences as **Repository Variables** (optional).
+
+### Environment Variables Reference
+
+| Variable                       | Type     | Possible Values                           | Default             | Description                                                                   |
+| ------------------------------ | -------- | ----------------------------------------- | ------------------- | ----------------------------------------------------------------------------- |
+| `ALIF_LLM_PROVIDER`            | Variable | `'anthropic'`, `'openrouter'`, `'ollama'` | `'anthropic'`       | The AI provider to use for analysis.                                          |
+| `ALIF_LLM_API_KEY`             | Secret   | _Your API Key_                            | -                   | Universal key. Alternatively use `ANTHROPIC_API_KEY` or `OPENROUTER_API_KEY`. |
+| `ALIF_LLM_MODEL`               | Variable | e.g. `'claude-3-5-sonnet-20240620'`       | _Provider Specific_ | The specific model to use.                                                    |
+| `SLACK_WEBHOOK_URL`            | Secret   | *https://hooks.slack.com/...*             | -                   | Webhook URL for Slack delivery.                                               |
+| `GENERIC_WEBHOOK_URL`          | Secret   | _https://..._                             | -                   | Webhook URL for generic server delivery.                                      |
+| `ALIF_SIGNAL_THRESHOLD`        | Variable | `0` - `100`                               | `60`                | Minimum score for an article to qualify.                                      |
+| `ALIF_MAX_ITEMS_PER_RUN`       | Variable | `1`+                                      | `10`                | Max articles delivered per run.                                               |
+| `ALIF_SOURCE_COOLDOWN_MINUTES` | Variable | `0`+                                      | `5`                 | Minimum gap between re-fetching a source.                                     |
+
+The included workflow automatically runs every day at 8:00 AM UTC (you can change the schedule in the file), caches your database state securely, and delivers your customized digest!
 
 ---
 

package/{.github/workflows → examples}/alif-scheduled-run.yml

@@ -20,7 +20,9 @@ jobs:
       - name: Cache Alif Data Directory
         uses: actions/cache@v4
         with:
-          path: .alif-data
+          path: |
+            .alif-data/alif.db
+            .alif-data/feeds.json
           key: ${{ runner.os }}-alif-data-${{ github.run_id }}
           restore-keys: |
             ${{ runner.os }}-alif-data-
@@ -64,5 +66,7 @@ jobs:
         if: always()
         uses: actions/cache/save@v4
         with:
-          path: .alif-data
+          path: |
+            .alif-data/alif.db
+            .alif-data/feeds.json
           key: ${{ runner.os }}-alif-data-${{ github.run_id }}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alif-digest",
-  "version": "1.1.2",
+  "version": "1.1.4",
   "description": "Autonomous AI Signal Digest CLI for tracking high-signal AI breakthroughs.",
   "type": "module",
   "publishConfig": {