platform-mem 0.3.0

Memory for linksplatform
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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
name: CI/CD Pipeline

on:
  push:
    branches:
      - main
  pull_request:
    types: [opened, synchronize, reopened]
  workflow_dispatch:
    inputs:
      release_mode:
        description: 'Manual release mode'
        required: true
        type: choice
        default: 'instant'
        options:
          - instant
          - changelog-pr
      bump_type:
        description: 'Version bump type'
        required: true
        type: choice
        options:
          - patch
          - minor
          - major
      description:
        description: 'Release description (optional)'
        required: false
        type: string

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: -Dwarnings
  # Support both CARGO_REGISTRY_TOKEN (cargo's native env var) and CARGO_TOKEN (for backwards compatibility)
  CARGO_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN || secrets.CARGO_TOKEN }}

jobs:
  # === DETECT CHANGES - determines which jobs should run ===
  detect-changes:
    name: Detect Changes
    runs-on: ubuntu-latest
    if: github.event_name != 'workflow_dispatch'
    outputs:
      rs-changed: ${{ steps.changes.outputs.rs-changed }}
      toml-changed: ${{ steps.changes.outputs.toml-changed }}
      docs-changed: ${{ steps.changes.outputs.docs-changed }}
      workflow-changed: ${{ steps.changes.outputs.workflow-changed }}
      any-code-changed: ${{ steps.changes.outputs.any-code-changed }}
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install rust-script
        run: cargo install rust-script

      - name: Detect changes
        id: changes
        env:
          GITHUB_EVENT_NAME: ${{ github.event_name }}
          GITHUB_BASE_SHA: ${{ github.event.pull_request.base.sha }}
          GITHUB_HEAD_SHA: ${{ github.event.pull_request.head.sha }}
        run: rust-script scripts/detect-code-changes.rs

  # === CHANGELOG CHECK - only runs on PRs with code changes ===
  # Docs-only PRs (./docs folder, markdown files) don't require changelog fragments
  changelog:
    name: Changelog Fragment Check
    runs-on: ubuntu-latest
    needs: [detect-changes]
    if: github.event_name == 'pull_request' && needs.detect-changes.outputs.any-code-changed == 'true'
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install rust-script
        run: cargo install rust-script

      - name: Check for changelog fragments
        env:
          GITHUB_BASE_REF: ${{ github.base_ref }}
        run: rust-script scripts/check-changelog-fragment.rs

  # === VERSION CHECK - prevents manual version modification in PRs ===
  # This ensures versions are only modified by the automated release pipeline
  version-check:
    name: Version Modification Check
    runs-on: ubuntu-latest
    if: github.event_name == 'pull_request'
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install rust-script
        run: cargo install rust-script

      - name: Check for manual version changes
        env:
          GITHUB_EVENT_NAME: ${{ github.event_name }}
          GITHUB_HEAD_REF: ${{ github.head_ref }}
          GITHUB_BASE_REF: ${{ github.base_ref }}
        run: rust-script scripts/check-version-modification.rs

  # === LINT AND FORMAT CHECK ===
  lint:
    name: Lint and Format Check
    runs-on: ubuntu-latest
    needs: [detect-changes]
    # Note: always() is required because detect-changes is skipped on workflow_dispatch,
    # and without always(), this job would also be skipped even though its condition includes workflow_dispatch.
    # See: https://github.com/actions/runner/issues/491
    if: |
      always() && !cancelled() && (
        github.event_name == 'push' ||
        github.event_name == 'workflow_dispatch' ||
        needs.detect-changes.outputs.rs-changed == 'true' ||
        needs.detect-changes.outputs.toml-changed == 'true' ||
        needs.detect-changes.outputs.docs-changed == 'true' ||
        needs.detect-changes.outputs.workflow-changed == 'true'
      )
    steps:
      - uses: actions/checkout@v6

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt, clippy

      - name: Install rust-script
        run: cargo install rust-script

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

      - name: Check formatting
        run: cargo fmt --all -- --check

      - name: Run Clippy
        run: cargo clippy --all-targets --all-features

      - name: Check file size limit
        run: rust-script scripts/check-file-size.rs

  # === TEST ===
  test:
    name: Test (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    needs: [detect-changes, changelog]
    # Run if: push event, OR changelog succeeded, OR changelog was skipped (docs-only PR)
    if: always() && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || needs.changelog.result == 'success' || needs.changelog.result == 'skipped')
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest]
    steps:
      - uses: actions/checkout@v6

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

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

      - name: Run tests
        run: cargo test --all-features --verbose

      - name: Run doc tests
        run: cargo test --doc --verbose

  # === BUILD ===
  build:
    name: Build Package
    runs-on: ubuntu-latest
    needs: [lint, test]
    if: always() && !cancelled() && needs.lint.result == 'success' && needs.test.result == 'success'
    steps:
      - uses: actions/checkout@v6

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

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

      - name: Build release
        run: cargo build --release --verbose

      - name: Check package
        run: cargo package --list

  # === AUTO RELEASE ===
  # Automatic release on push to main using changelog fragments
  auto-release:
    name: Auto Release
    needs: [lint, test, build]
    if: |
      always() && !cancelled() &&
      github.event_name == 'push' &&
      github.ref == 'refs/heads/main' &&
      needs.build.result == 'success'
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install rust-script
        run: cargo install rust-script

      - name: Configure git
        run: rust-script scripts/git-config.rs

      - name: Determine bump type from changelog fragments
        id: bump_type
        run: rust-script scripts/get-bump-type.rs

      - name: Check if version already released or no fragments
        id: check
        env:
          HAS_FRAGMENTS: ${{ steps.bump_type.outputs.has_fragments }}
        run: rust-script scripts/check-release-needed.rs

      - name: Collect changelog and bump version
        id: version
        if: steps.check.outputs.should_release == 'true' && steps.check.outputs.skip_bump != 'true'
        run: |
          rust-script scripts/version-and-commit.rs \
            --bump-type "${{ steps.bump_type.outputs.bump_type }}"

      - name: Get current version
        id: current_version
        if: steps.check.outputs.should_release == 'true'
        run: rust-script scripts/get-version.rs

      - name: Build release
        if: steps.check.outputs.should_release == 'true'
        run: cargo build --release

      - name: Publish to Crates.io
        if: steps.check.outputs.should_release == 'true'
        id: publish-crate
        env:
          CARGO_TOKEN: ${{ secrets.CARGO_TOKEN }}
        run: rust-script scripts/publish-crate.rs

      - name: Create GitHub Release
        if: steps.check.outputs.should_release == 'true'
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          # Use new_version from version-and-commit when available (tag-checked), else fall back to Cargo.toml version
          RELEASE_VERSION="${{ steps.version.outputs.new_version }}"
          if [ -z "$RELEASE_VERSION" ]; then
            RELEASE_VERSION="${{ steps.current_version.outputs.version }}"
          fi
          rust-script scripts/create-github-release.rs --release-version "$RELEASE_VERSION" --repository "${{ github.repository }}"

  # === MANUAL INSTANT RELEASE ===
  manual-release:
    name: Instant Release
    needs: [lint, test, build]
    if: |
      always() && !cancelled() &&
      github.event_name == 'workflow_dispatch' &&
      github.event.inputs.release_mode == 'instant' &&
      needs.build.result == 'success'
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install rust-script
        run: cargo install rust-script

      - name: Configure git
        run: rust-script scripts/git-config.rs

      - name: Collect changelog fragments
        run: rust-script scripts/collect-changelog.rs

      - name: Version and commit
        id: version
        env:
          BUMP_TYPE: ${{ github.event.inputs.bump_type }}
          DESCRIPTION: ${{ github.event.inputs.description }}
        run: rust-script scripts/version-and-commit.rs --bump-type "${{ github.event.inputs.bump_type }}" --description "${{ github.event.inputs.description }}"

      - name: Build release
        if: steps.version.outputs.version_committed == 'true' || steps.version.outputs.already_released == 'true'
        run: cargo build --release

      - name: Publish to Crates.io
        if: steps.version.outputs.version_committed == 'true' || steps.version.outputs.already_released == 'true'
        id: publish-crate
        env:
          CARGO_TOKEN: ${{ secrets.CARGO_TOKEN }}
        run: rust-script scripts/publish-crate.rs

      - name: Create GitHub Release
        if: steps.version.outputs.version_committed == 'true' || steps.version.outputs.already_released == 'true'
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: rust-script scripts/create-github-release.rs --release-version "${{ steps.version.outputs.new_version }}" --repository "${{ github.repository }}"

  # === DEPLOY DOCUMENTATION ===
  deploy-docs:
    name: Deploy Rust Documentation
    needs: [auto-release, manual-release]
    if: |
      always() && !cancelled() && (
        needs.auto-release.result == 'success' ||
        needs.manual-release.result == 'success'
      )
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v6
        with:
          ref: main

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Build documentation
        run: cargo doc --no-deps

      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: target/doc
          destination_dir: rust
          keep_files: true

  # === MANUAL CHANGELOG PR ===
  changelog-pr:
    name: Create Changelog PR
    if: github.event_name == 'workflow_dispatch' && github.event.inputs.release_mode == 'changelog-pr'
    runs-on: ubuntu-latest
    permissions:
      contents: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable

      - name: Install rust-script
        run: cargo install rust-script

      - name: Create changelog fragment
        env:
          BUMP_TYPE: ${{ github.event.inputs.bump_type }}
          DESCRIPTION: ${{ github.event.inputs.description }}
        run: rust-script scripts/create-changelog-fragment.rs --bump-type "${{ github.event.inputs.bump_type }}" --description "${{ github.event.inputs.description }}"

      - name: Create Pull Request
        uses: peter-evans/create-pull-request@v8
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          commit-message: 'chore: add changelog for manual ${{ github.event.inputs.bump_type }} release'
          branch: changelog-manual-release-${{ github.run_id }}
          delete-branch: true
          title: 'chore: manual ${{ github.event.inputs.bump_type }} release'
          body: |
            ## Manual Release Request

            This PR was created by a manual workflow trigger to prepare a **${{ github.event.inputs.bump_type }}** release.

            ### Release Details
            - **Type:** ${{ github.event.inputs.bump_type }}
            - **Description:** ${{ github.event.inputs.description || 'Manual release' }}
            - **Triggered by:** @${{ github.actor }}

            ### Next Steps
            1. Review the changelog fragment in this PR
            2. Merge this PR to main
            3. The automated release workflow will publish to crates.io and create a GitHub release