nut-shell 0.1.2

A lightweight command-line interface library for embedded systems
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

name: Memory Footprint Analysis

on:
  pull_request:
    paths:
      - 'src/**'
      - 'Cargo.toml'
      - 'size-analysis/**'
  push:
    branches:
      - main
  workflow_dispatch:  # Allow manual trigger

jobs:
  size-analysis:
    name: Analyze Binary Size
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write

    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@stable
        with:
          targets: thumbv6m-none-eabi

      - name: Cache cargo registry
        uses: actions/cache@v5
        with:
          path: ~/.cargo/registry
          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}

      - name: Cache cargo index
        uses: actions/cache@v5
        with:
          path: ~/.cargo/git
          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}

      - name: Cache cargo build
        uses: actions/cache@v5
        with:
          path: size-analysis/minimal/target
          key: ${{ runner.os }}-cargo-build-size-${{ hashFiles('size-analysis/minimal/Cargo.lock') }}

      - name: Cache cargo binaries
        uses: actions/cache@v5
        with:
          path: ~/.cargo/bin
          key: ${{ runner.os }}-cargo-bin-${{ hashFiles('**/Cargo.lock') }}
          restore-keys: |
            ${{ runner.os }}-cargo-bin-

      - name: Install llvm-tools component
        run: rustup component add llvm-tools

      - name: Install cargo-bloat and cargo-binutils
        run: |
          cargo install cargo-bloat --locked || echo "cargo-bloat already installed"
          cargo install cargo-binutils --locked || echo "cargo-binutils already installed"

      - name: Run size analysis
        run: |
          cd size-analysis
          ./analyze.sh

      - name: Upload size report
        uses: actions/upload-artifact@v7
        with:
          name: size-analysis-report
          path: size-analysis/report.md
          retention-days: 90

      - name: Comment PR with summary (on pull requests)
        if: github.event_name == 'pull_request'
        uses: actions/github-script@v8
        with:
          script: |
            const fs = require('fs');
            const report = fs.readFileSync('size-analysis/report.md', 'utf8');

            // Extract summary table from report
            const summaryStart = report.indexOf('## Summary Table');
            const summaryEnd = report.indexOf('\n---\n', summaryStart);
            const summary = report.substring(summaryStart, summaryEnd);

            const body = `## Memory Footprint Analysis

            ${summary}

            <details>
            <summary>📊 View Full Report</summary>

            [Download the complete analysis report](https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }})

            </details>

            > This is an informational report. Size increases may be justified for feature additions.`;

            // Find existing comment
            const { data: comments } = await github.rest.issues.listComments({
              owner: context.repo.owner,
              repo: context.repo.repo,
              issue_number: context.issue.number,
            });

            const botComment = comments.find(comment =>
              comment.user.type === 'Bot' &&
              comment.body.includes('Memory Footprint Analysis')
            );

            if (botComment) {
              // Update existing comment
              await github.rest.issues.updateComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                comment_id: botComment.id,
                body: body
              });
            } else {
              // Create new comment
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.issue.number,
                body: body
              });
            }