Skip to main content

TradingView Description Generation - When and How

📅 When tv-description.txt Gets Generated​

The tv-description.txt file is NOT automatically generated during regular commits. It is only created during specific workflow phases:

❌ NOT Generated During:​

  • ✅ Regular commits - No tv-description generation
  • ✅ Pre-commit hook - Only validation, no file generation
  • ✅ Post-commit hook - Runs test phase only (no tv-description)
  • ✅ one-command.sh test - Prepares for testing, no tv-description

✅ Generated During:​

  • 🚀 one-command.sh publish - Creates tv-description.txt for publication
  • 🚀 workflow.sh pre-publish - Called by publish phase
  • 🚀 Manual conversion - Using convert-to-tv.sh directly

🔄 Workflow Phases​

Phase 1: Test (one-command.sh test)​

Purpose: Prepare for TradingView testing Automatic: Yes (via post-commit hook) Files Generated:

  • ✅ Pine script version updates
  • ✅ README.md version badges
  • ✅ changelog.md entries
  • ✅ testing-checklist.md
  • ❌ NO tv-description.txt

Phase 2: Publish (one-command.sh publish)​

Purpose: Prepare for TradingView publication Automatic: No (manual command) Files Generated:

  • ✅ All Phase 1 files
  • ✅ tv-description.txt (converted from README.md)
  • ✅ publication-checklist.md

Phase 3: Complete (one-command.sh complete)​

Purpose: Post-publication archival Automatic: No (manual command) Files Generated:

  • ✅ Archived tv-description files
  • ✅ Git tags
  • ✅ Final documentation

🛠️ Manual Generation​

To manually generate tv-description.txt:

# Option 1: Full publish workflow
./tools/one-command.sh indicators/trend/macdrsi-plus 2.6.0 publish

# Option 2: Direct conversion
./tools/convert-to-tv.sh indicators/trend/macdrsi-plus/README.md indicators/trend/macdrsi-plus/docs/tv-description.txt

🎯 Current State (July 4, 2025)​

MACDRSI+ Indicator Status:​

  • Current Version: v2.6.0
  • Last Test Phase: ✅ Completed (auto-generated via post-commit)
  • Publication Phase: ❌ Not run (tv-description.txt manually updated)
  • Ready for: TradingView testing

To Prepare for Publication:​

./tools/one-command.sh indicators/trend/macdrsi-plus 2.6.0 publish

This will:

  1. Validate all files are synchronized
  2. Generate fresh tv-description.txt from README.md
  3. Create publication checklist
  4. Prepare all files for TradingView publication

🧹 Artifacts Cleaned Up​

Removed Files:

  • ❌ tv-description-backup.txt (outdated backup)
  • ❌ tv-description-final.txt (redundant version)
  • ❌ Duplicate changelog entries in Pine script

Updated Files:

  • ✅ tv-description.txt - Updated version history to v2.6.0
  • ✅ macdrsc.pine - Cleaned up duplicate changelog entries
  • ✅ All documentation now reflects current state

💡 Key Takeaway​

The post-commit hook only runs the TEST phase, which prepares files for testing but does NOT generate the TradingView description. The tv-description.txt must be generated manually when you're ready to publish on TradingView by running the PUBLISH phase.