dpla/dpla-script-workflow
docs/ai-context/archive/cursor-skills/dpla-script-workflow/SKILL.md
Follow the project workflow when adding or modifying shell or Python scripts. Use when the user asks to add a script, create a new script, modify a script, or write a script for a task. Ensures POSIX bash, common.sh, documentation in SCRIPTS.md, and tests are created or updated and run.
$ install --global
skillsauthnpx skillsauth add dpla/ingestion3 dpla-script-workflowInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: May 26, 2026, 3:37 AM126.7s1 file scanned
SKILL.md
- name:
- dpla-script-workflow
- description:
- Follow the project workflow when adding or modifying shell or Python scripts. Use when the user asks to add a script, create a new script, modify a script, or write a script for a task. Ensures POSIX bash, common.sh, documentation in SCRIPTS.md, and tests are created or updated and run.
DPLA Script Workflow
Purpose
When adding or modifying scripts in this repo, follow the project's conventions so scripts are documented, portable, and tested.
When to Use
- "Add a script for..."
- "New script to..."
- "Modify script X"
- "Create a script that..."
- "Script for [task]"
Environment: When running the test suite or any script that depends on project env, run source .env from repo root first.
Project Rules (apply to all new/changed scripts)
- Python: Use the virtualenv at
./venv/(e.g../venv/bin/pythonorsource ./venv/bin/activate). Never assume system Python. - AWS CLI: Use
--profile dplafor any AWS commands. - Shell scripts: Write POSIX-compliant bash. Avoid macOS- or Linux-specific flags (e.g.
sed -i,readlink -f). Use helpers fromscripts/common.sh:sed_i,get_script_dir,get_common_dir,log_info,die, etc.
Workflow Checklist
For new scripts
- [ ] Implement using
scripts/common.shif bash (source it, use its helpers). - [ ] Add to Quick Reference table in scripts/SCRIPTS.md (script name, purpose, usage).
- [ ] If non-trivial, add a Script Details subsection in SCRIPTS.md (purpose, usage, env vars).
- [ ] Add or extend tests in
scripts/tests/test-scripts.sh(or underscripts/tests/as appropriate). - [ ] Run
./scripts/tests/test-scripts.sh(or--quickfor syntax) before committing.
For modified scripts
- [ ] Update SCRIPTS.md if behavior or usage changed (Quick Reference and/or Script Details).
- [ ] Update tests if behavior changed; add tests for new behavior.
- [ ] Run
./scripts/tests/test-scripts.shbefore committing.
Key References
| Resource | Path | |----------|------| | Script docs | scripts/SCRIPTS.md | | Updating docs | SCRIPTS.md section "Updating This Documentation" | | Shared helpers | scripts/common.sh | | Test suite | scripts/tests/test-scripts.sh |
Quick Commands
# Run full script test suite
./scripts/tests/test-scripts.sh
# Quick syntax / lightweight checks
./scripts/tests/test-scripts.sh --quick
# Verbose test output
./scripts/tests/test-scripts.sh --verbose
Example: Adding a new bash script
- Create script under
scripts/with shebang#!/usr/bin/env bash,set -euo pipefail, andsource "$(get_script_dir)/common.sh"(or equivalent via get_common_dir). - Use
sed_i,get_script_dir,log_info,dieinstead of rawsed -iorreadlink -f. - Add row to Quick Reference in SCRIPTS.md.
- Add a test in
scripts/tests/test-scripts.sh(e.g. syntax check, help output, or sourcing common.sh). - Run
./scripts/tests/test-scripts.shand fix any failures.
Related Skills
dpla/dpla-hub-info
data-ai
VerifiedTrustedCommunity
Show key i3.conf config for a hub (provider, harvest.type, harvest.endpoint, schedule, email, setlist). Use when user asks for hub config, harvest type/endpoint, who gets emails, schedule months, or OAI setlist details.
35SKILL.mdUpdated Apr 16, 2026
dpla/dpla-community-webs-ingest
development
VerifiedTrustedCommunity
Run Community Webs ingest. Use when the user says harvest community-webs, run community-webs ingest, export community webs, or process community webs DB.
35SKILL.mdUpdated Apr 15, 2026
dpla/dpla-verify-and-notify
testing
VerifiedTrustedCommunity
Verify ingest outcomes and send failure or status notifications to Slack or [email protected]. Use when the user asks to verify the ingest, check if it succeeded, notify about a failure, or post to tech-alerts.
33SKILL.mdUpdated May 26, 2026
dpla/dpla-staged-report
business
VerifiedTrustedCommunity
Report which hubs have new JSONL staged in S3 for a given month, and optionally post the report to Slack. Use when user asks what hubs are staged/ready for indexing, /ingest staged, or what changed this month in S3.
33SKILL.mdUpdated May 26, 2026