alif-digest 1.1.3 → 1.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -158,12 +158,13 @@ Config is stored at `~/.config/alif/config.json`. Most values can be changed wit
|
|
|
158
158
|
|
|
159
159
|
## ☁️ Running on GitHub Actions (Free)
|
|
160
160
|
|
|
161
|
-
|
|
161
|
+
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.
|
|
162
162
|
|
|
163
|
-
1. **
|
|
164
|
-
2.
|
|
165
|
-
3.
|
|
166
|
-
4.
|
|
163
|
+
1. **Create a new Private Repository** on GitHub.
|
|
164
|
+
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`.
|
|
165
|
+
3. Navigate to your private repository's **Settings > Secrets and variables > Actions**.
|
|
166
|
+
4. Add your sensitive access credentials as **Repository Secrets**.
|
|
167
|
+
5. Configure your preferences as **Repository Variables** (optional).
|
|
167
168
|
|
|
168
169
|
### Environment Variables Reference
|
|
169
170
|
|
|
@@ -178,7 +179,7 @@ You can run Alif entirely in the cloud for free using GitHub Actions, without ev
|
|
|
178
179
|
| `ALIF_MAX_ITEMS_PER_RUN` | Variable | `1`+ | `10` | Max articles delivered per run. |
|
|
179
180
|
| `ALIF_SOURCE_COOLDOWN_MINUTES` | Variable | `0`+ | `5` | Minimum gap between re-fetching a source. |
|
|
180
181
|
|
|
181
|
-
The included workflow
|
|
182
|
+
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!
|
|
182
183
|
|
|
183
184
|
---
|
|
184
185
|
|
|
@@ -20,7 +20,9 @@ jobs:
|
|
|
20
20
|
- name: Cache Alif Data Directory
|
|
21
21
|
uses: actions/cache@v4
|
|
22
22
|
with:
|
|
23
|
-
path:
|
|
23
|
+
path: |
|
|
24
|
+
.alif-data/alif.db
|
|
25
|
+
.alif-data/feeds.json
|
|
24
26
|
key: ${{ runner.os }}-alif-data-${{ github.run_id }}
|
|
25
27
|
restore-keys: |
|
|
26
28
|
${{ runner.os }}-alif-data-
|
|
@@ -64,5 +66,7 @@ jobs:
|
|
|
64
66
|
if: always()
|
|
65
67
|
uses: actions/cache/save@v4
|
|
66
68
|
with:
|
|
67
|
-
path:
|
|
69
|
+
path: |
|
|
70
|
+
.alif-data/alif.db
|
|
71
|
+
.alif-data/feeds.json
|
|
68
72
|
key: ${{ runner.os }}-alif-data-${{ github.run_id }}
|