메뉴
Use when upgrading SourceMonitor to a new gem version, including CHANGELOG review, running the upgrade command, interpreting verification results, and handling configuration deprecations.
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
| name | sm-upgrade |
| description | Use when upgrading SourceMonitor to a new gem version, including CHANGELOG review, running the upgrade command, interpreting verification results, and handling configuration deprecations. |
| allowed-tools | Read, Write, Edit, Bash, Glob, Grep |
Guides AI agents through upgrading SourceMonitor in a host Rails application after a new gem version is released. Covers CHANGELOG review, running the upgrade command, interpreting verification results, handling deprecation warnings, and resolving common edge cases.
| Requirement | How to Check |
|---|---|
| Existing SourceMonitor installation | cat .source_monitor_version or check config/initializers/source_monitor.rb |
| Access to CHANGELOG.md | Bundled with gem: bundle show source_monitor then read CHANGELOG.md |
| Current gem version known | grep source_monitor Gemfile.lock |
CHANGELOG.md in the gem source. Identify changes between the current installed version (from .source_monitor_version or Gemfile.lock) and the target version. Focus on Added, Changed, Fixed, Removed sections. Flag any breaking changes or deprecation notices.gem "source_monitor", "~> X.Y". Run bundle update source_monitor.bin/rails source_monitor:upgrade. This automatically: detects the version change via .source_monitor_version marker, copies new migrations, re-runs the install generator (idempotent), runs the full verification suite.bin/rails db:migrate if the upgrade command copied new migrations.sm-configure skill for configuration reference.bin/rails source_monitor:setup:verify to confirm all checks pass.The upgrade command runs 4 verification checks automatically:
| Check | OK | Failure | Fix |
|---|---|---|---|
| PendingMigrations | All engine migrations present | Missing migrations need copying | bin/rails db:migrate |
| SolidQueue | Workers running | Workers not detected | Start Solid Queue workers via Procfile.dev or bin/rails solid_queue:start |
| RecurringSchedule | Tasks registered | Tasks missing from dispatcher | Re-run generator or check config/queue.yml |
| ActionCable | Adapter configured | No production adapter | Configure Solid Cable or Redis adapter |
The deprecation framework uses two severity levels:
:warning -- Option renamed. The old name still works but logs a deprecation message. Update the initializer to use the new option name. The message includes the replacement path.:error -- Option removed. Using the old name raises SourceMonitor::DeprecatedOptionError. You must remove or replace the option before the app can boot.Pattern for fixing deprecations:
Rails.logger or raised as an error)config/initializers/source_monitor.rbExample deprecation message:
[SourceMonitor] DEPRECATION: 'http.old_option' was deprecated in v0.5.0 and replaced by 'http.new_option'.
.source_monitor_version file): Upgrade command treats this as a version change and runs the full workflow. Safe to run on first install.db:migrate), missing Solid Queue workers (start workers), stale recurring schedule (re-run generator).Scrapers::Base or event callback signatures.| File | Purpose |
|---|---|
lib/source_monitor/setup/upgrade_command.rb | Upgrade orchestrator |
lib/source_monitor/setup/cli.rb | CLI entry point (Thor, used in development) |
lib/source_monitor/setup/verification/runner.rb | Verification runner (4 verifiers) |
lib/source_monitor/configuration/deprecation_registry.rb | Deprecation framework |
CHANGELOG.md | Version history (Keep a Changelog format) |
.source_monitor_version | Version marker in host app root |
docs/upgrade.md -- Human-readable upgrade guidedocs/setup.md -- Initial setup documentationdocs/troubleshooting.md -- Common issues and fixessm-host-setup skill -- Initial installation workflowsm-configure skill -- Configuration reference for updating deprecated optionsbundle update source_monitor runbin/rails source_monitor:upgrade completed successfullybin/rails source_monitor:setup:verify passes all checksHow to add or modify configuration settings in the Source Monitor engine. Use when adding a new config option, modifying defaults, creating a new settings section, or understanding the configuration architecture.
Use when configuring SourceMonitor engine settings via the DSL, including queue settings, HTTP client, fetching, health, scrapers, retention, scraping controls, events, model extensions, realtime, and authentication.
Use when setting up SourceMonitor in a host Rails application, including gem installation, engine mounting, migration copying, initializer creation, and verifying the install works.
Use when working with SourceMonitor lifecycle events and callbacks, including after_item_created, after_item_scraped, after_fetch_completed, and item processors.
Provides SourceMonitor engine architecture context. Use when working with engine internals, lib/ module structure, autoload organization, configuration DSL, pipelines, or any structural/organizational code in the source_monitor namespace.
Solid Queue job conventions for the SourceMonitor engine. Use when creating new background jobs, modifying existing jobs, configuring queues, or working with job scheduling and retry policies.