arol-ai 0.1.4 → 0.1.5
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 +20 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -134,6 +134,26 @@ npx arol-ai scan --within 7 # only fail when a sunset is within a week
|
|
|
134
134
|
|
|
135
135
|
Colors are automatically disabled when output is not a TTY (e.g. piped to a file), or when `NO_COLOR` is set. Use `FORCE_COLOR=1` to force them on.
|
|
136
136
|
|
|
137
|
+
## Run arol in CI
|
|
138
|
+
|
|
139
|
+
Add a workflow file at `.github/workflows/arol.yml` in **your own repo**. GitHub Actions runs anything in `.github/workflows/` automatically — the filename is arbitrary — and this one triggers on every `push` and `pull_request`:
|
|
140
|
+
|
|
141
|
+
```yaml
|
|
142
|
+
name: arol deprecation scan
|
|
143
|
+
on: [push, pull_request]
|
|
144
|
+
jobs:
|
|
145
|
+
scan:
|
|
146
|
+
runs-on: ubuntu-latest
|
|
147
|
+
steps:
|
|
148
|
+
- uses: actions/checkout@v4
|
|
149
|
+
- uses: actions/setup-node@v4
|
|
150
|
+
with: { node-version: 20 }
|
|
151
|
+
- run: npx arol-ai scan
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
1. **Exit codes fail the build only on real breaks.** The scan exits non-zero only for high-severity or imminent dated deprecations, and stays warn-only (exit `0`) for `deprecated`/`medium` findings — so it won't block a PR over a deprecation that has no deadline.
|
|
155
|
+
2. **Portable to any CI.** `npx arol-ai scan` is the one line that matters (GitLab CI, CircleCI, a cron job, etc.); only the YAML wrapper above is GitHub-specific.
|
|
156
|
+
|
|
137
157
|
## The dataset (`deprecations.json`)
|
|
138
158
|
|
|
139
159
|
All detections are **data-driven** — the bundled dataset lives at
|
package/package.json
CHANGED