Lesson 2: Publishing Bundles

Publishing Your First Bundle

# Navigate to your repo
cd /path/to/user-service

# Publish the architecture bundle
sruja publish -r . -o repo.bundle.json

This creates repo.bundle.json with:

• Architecture DSL snapshot
• Context graph
• Truth status
• Git commit reference

Bundle Structure

{
  "schema_version": "1",
  "repo_id": "user-service",
  "repo_path": "/path/to/user-service",
  "git_commit": "a1b2c3d",
  "baseline_path": "repo.sruja",
  "baseline_dsl": "UserService = system \"User Service\" { ... }",
  "context": {
    "components": [...],
    "edges": [...]
  },
  "truth_status": "reviewed",
  "updated_at": "2024-05-12T10:30:00Z"
}

Publishing to a Shared Location

For federation, publish to a shared location:

# Publish to shared bundles directory
sruja publish -r ./user-service -o ./shared/bundles/user-service.bundle.json
sruja publish -r ./order-service -o ./shared/bundles/order-service.bundle.json
sruja publish -r ./payment-service -o ./shared/bundles/payment-service.bundle.json

Bundle Versioning

Bundles are tied to git commits:

# Publish with specific version
sruja publish -r . -o repo.bundle.json --version 1.0.0

# Publish from specific commit
git checkout v1.0.0
sruja publish -r . -o repo.bundle.json

Automated Publishing in CI/CD

# .github/workflows/publish-bundle.yml
name: Publish Architecture Bundle

on:
  push:
    branches: [main]

jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install Sruja
        run: curl -fsSL https://sruja.ai/install.sh | bash

      - name: Publish Bundle
        run: |
          sruja publish -r . -o bundle.json

      - name: Upload Bundle
        uses: actions/upload-artifact@v4
        with:
          name: architecture-bundle
          path: bundle.json

Refreshing Bundles

# Re-publish with latest context
sruja publish -r . -o repo.bundle.json --force

# Or run sruja sync first to update context
sruja sync -r .
sruja publish -r . -o repo.bundle.json

Bundle Contents Deep Dive

context.components

{
  "id": "UserAPI",
  "kind": "container",
  "label": "User API",
  "description": "REST API for user management",
  "technology": "Node.js",
  "repo_id": "user-service"
}

context.edges

{
  "source": "user-service::UserAPI",
  "target": "user-service::UserDB",
  "label": "SQL"
}

Best Practices

Hands-On: Publish Your First Bundle

1. Initialize or use an existing repo:

   cd /path/to/your-repo
   sruja init --auto  # if not already initialized
   

2. Publish a bundle:

   sruja publish -r . -o repo.bundle.json
   

3. Inspect the bundle contents:

   cat repo.bundle.json | jq '{repo_id, git_commit, truth_status, schema_version}'
   

4. View the components in the bundle:

   cat repo.bundle.json | jq '.context.components[0:2]'
   

5. Set up automated publishing (optional - for CI/CD):

   • Create a GitHub Actions workflow as shown above
   • Or add to existing CI pipeline

Learning Outcomes

• ✅ Publish an architecture bundle from any repository
• ✅ Understand the bundle JSON structure and contents
• ✅ Identify the key fields in a bundle (repo_id, context, truth_status)
• ✅ Set up automated bundle publishing in CI/CD

Quiz: Test Your Understanding

Q1: What does the truth_status field in a bundle indicate?

A) Whether the bundle is encrypted B) The version of the bundle schema C) Whether the architecture matches the actual code (reviewed/drifted/unknown) D) The number of components in the bundle

Q2: Why should bundles be published from the main branch?

A) Main branch has faster network access B) Main branch ensures consistency and represents the current architecture truth C) Bundles cannot be published from other branches D) Main branch is required by GitHub

Q3: What is the recommended way to keep bundles up-to-date?

A) Manually publish before each meeting B) Automate publishing in CI/CD on every push to main C) Only publish when a new release is tagged D) Use a scheduled cron job to publish daily

Next Steps

Lesson 3 covers composing bundles into a system index.