tnuctipun 0.2.0

The Tnuctipun of Ringworld — ancient, subversive, ingenious — or a type-safe MongoDB builder library
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

name: Documentation

on:
  push:
    branches: [ master ]
    paths:
      - '**/*.md'
      - 'docs/**'
      - '.github/workflows/docs.yml'
  pull_request:
    branches: [ master ]
    paths:
      - '**/*.md'
      - 'docs/**'
      - '.github/workflows/docs.yml'

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: 1

jobs:
  doc_validation:
    name: Documentation Validation
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
    
    - name: Install 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-docs-validation-${{ hashFiles('Cargo.lock', 'tnuctipun-derive/Cargo.lock') }}
        restore-keys: |
          ${{ runner.os }}-cargo-docs-validation-
          ${{ runner.os }}-cargo-
    
    - name: Setup Ruby for Jekyll
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: '3.1'
        bundler-cache: true
        working-directory: ./docs

    - name: Setup Node.js
      uses: actions/setup-node@v6
      with:
        node-version: '20'

    - name: Install Jekyll dependencies
      run: |
        cd docs
        gem install bundler
        bundle install

    - name: Validate Jekyll build
      run: |
        cd docs
        bundle exec jekyll build --destination ../_site_validation
        echo "✅ Jekyll build validation successful"

  doc_build:
    name: Documentation Preparation
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6

    - name: Setup Pages (for deployment)
      uses: actions/configure-pages@v5
      if: github.ref == 'refs/heads/master' && github.event_name == 'push'

    - name: Setup Ruby for Jekyll
      uses: ruby/setup-ruby@v1
      with:
        ruby-version: '3.1'
        bundler-cache: true
        working-directory: ./docs
      if: github.ref == 'refs/heads/master' && github.event_name == 'push'

    - name: Install Jekyll dependencies
      run: |
        cd docs
        gem install bundler
        bundle install
      if: github.ref == 'refs/heads/master' && github.event_name == 'push'

    - name: Build user guide with Jekyll
      run: |
        cd docs
        bundle exec jekyll build --destination ../_site
      if: github.ref == 'refs/heads/master' && github.event_name == 'push'

    - name: Upload Pages artifact
      uses: actions/upload-pages-artifact@v4
      if: github.ref == 'refs/heads/master' && github.event_name == 'push'
      with:
        path: ./_site

  doc_snippets:
    name: Documentation Snippets
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v6
    
    - name: Set up Go
      uses: actions/setup-go@v6
      with:
        go-version: '1.21'
    
    - name: Install 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-doc-snippets-${{ hashFiles('Cargo.lock', 'tnuctipun-derive/Cargo.lock') }}
        restore-keys: |
          ${{ runner.os }}-cargo-doc-snippets-
          ${{ runner.os }}-cargo-
    
    - name: Build doc-checker
      run: |
        cd tools/doc-checker
        go build -o doc-checker .
        test -f go.sum || touch go.sum
    
    - name: Check documentation snippets
      run: ./tools/doc-checker/doc-checker -o json

  doc_deploy:
    name: Documentation Deploy
    if: github.ref == 'refs/heads/master' && github.event_name == 'push'
    needs:
      - doc_validation
      - doc_snippets
      - doc_build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
    - name: Deploy to GitHub Pages
      id: deployment
      uses: actions/deploy-pages@v4