solarboat 0.2.0

A CLI tool for intelligent Terraform operations management with automatic dependency detection
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

name: 'Solarboat Action'
description: 'GitHub Action for Infrastructure as Code management with Solarboat CLI'
branding:
  icon: 'anchor'
  color: 'blue'

inputs:
  command:
    description: 'Command to run (scan or plan)'
    required: false
    default: 'scan'
  plan_output_dir:
    description: 'Directory for terraform plan outputs'
    required: false
    default: 'terraform-plans'
  apply_dry_run:
    description: 'Enable or disable solarboat apply in dry-run mode'
    required: false
    default: 'true'
  github_token:
    description: 'GitHub token for PR comments'
    required: true

runs:
  using: 'composite'
  steps:
    - name: Install Rust
      uses: dtolnay/rust-toolchain@stable

    - name: Install Solarboat CLI
      shell: bash
      run: |
        # Install Solarboat CLI using cargo
        cargo install solarboat
        
        # Verify installation
        solarboat --version || (echo "Installation failed" && exit 1)

    - name: Run Solarboat CLI
      shell: bash
      run: |
        echo "🚀 Running Solarboat CLI"
        
        if [[ "${{ inputs.command }}" == "scan" ]]; then
          echo "🔍 Scanning for changed modules..."
          solarboat scan
        elif [[ "${{ inputs.command }}" == "plan" ]]; then
          echo "📋 Running Terraform plan..."
          solarboat plan --output-dir ${{ inputs.plan_output_dir }}
        elif [[ "${{ inputs.command }}" == "apply" ]]; then
          echo "🧱 Running Terraform apply..."
          solarboat apply --dry-run=${{ inputs.apply_dry_run }}
        else
          echo "❌ Invalid command: ${{ inputs.command }}"
          exit 1
        fi

    - name: Upload Terraform Plans
      if: inputs.command == 'plan'
      uses: actions/upload-artifact@v4
      with:
        name: terraform-plans
        path: ${{ inputs.output_dir }}/
        retention-days: 5

    - name: Comment on PR
      if: github.event_name == 'pull_request' && inputs.command == 'plan'
      uses: actions/github-script@v7
      with:
        github-token: ${{ inputs.github_token }}
        script: |
          const artifactUrl = `${process.env.GITHUB_SERVER_URL}/${process.env.GITHUB_REPOSITORY}/actions/runs/${process.env.GITHUB_RUN_ID}/artifacts`;
          
          const comment = `## 🚀 Solarboat CLI Results

          Solarboat has analyzed your Terraform changes and generated plans.
          
          ### 📋 Summary
          - ✨ Plans have been generated and uploaded as artifacts
          - 🔍 Review the plans before merging
          - ⏱ī¸ Plans will be retained for 5 days
          
          ### 🔗 Links
          - [View Plan Artifacts](${artifactUrl})
          
          ### ℹī¸ Next Steps
          1. Download and review the plan artifacts
          2. Address any issues found in the plans
          3. Merge the PR when ready
          
          > Note: Check the action logs for detailed module processing information.`;
          
          github.rest.issues.createComment({
            owner: context.repo.owner,
            repo: context.repo.repo,
            issue_number: context.issue.number,
            body: comment
          });