Skip to content

Releases

The Runbook 0.1.0

Choose a tag to compare

@github-actions github-actions released this 19 Nov 18:49
33441eb

The Runbook 0.1.0

Schema: postgres 38 · d1 1022 · execution_do 6 · org_do 1 · webhook_do 2 (/v1/meta reports it; runbook-server --version prints the Postgres one).

Upgrade notes

  • Docker: deploy/update.sh --to 0.1.0 (backup, health check, rollback; docs/install.md §11).
  • Cloudflare: npm run update -- --to 0.1.0 in cloudflare/ (README §0a).
  • New migrations in this first release (applied by the update):
    • postgres: 0001_history.sql, 0002_execution_catalog.sql, 0003_directory.sql, 0004_directory_member_org.sql, 0005_work_lease.sql, 0006_org_roles.sql, 0007_blobs_tombstones.sql, 0008_credentials.sql, 0009_catalog_publication.sql, 0010_skills.sql, 0011_instance_bootstrap.sql, 0012_run_search.sql, 0013_directory_api.sql, 0014_start_admission.sql, 0015_draft_source_bytes.sql, 0016_owner_recovery_audit.sql, 0017_claims.sql, 0018_start_replay_retention.sql, 0019_execution_credentials.sql, 0020_actor_replay_step_index.sql, 0021_webhooks.sql, 0022_webhook_follow_ups.sql, 0023_review_indexes.sql, 0024_step_run_tombstone.sql, 0025_inbox_index.sql, 0026_memory.sql, 0027_auth_links_invitations_device.sql, 0028_uploads.sql, 0029_archives_retention.sql, 0030_quotas_usage.sql, 0031_rate_limits.sql, 0032_run_summary_runbook_indexes.sql, 0033_runbook_listing_order.sql, 0034_blob_objects.sql, 0035_notify.sql, 0036_project_slack.sql, 0037_pictures_invitation_name.sql, 0038_project_archived.sql
    • d1: 0001_history.sql, 0002_execution_catalog.sql, 0003_directory.sql, 0004_directory_member_org.sql, 0005_work_lease.sql, 0006_org_roles.sql, 0007_blobs_tombstones.sql, 0008_credentials.sql, 0009_catalog_publication.sql, 0010_skills.sql, 0011_instance_bootstrap.sql, 0012_run_search.sql, 0013_directory_api.sql, 0014_start_admission.sql, 0015_draft_source_bytes.sql, 0016_owner_recovery_audit.sql, 0017_claims.sql, 0018_start_replay_retention.sql, 0019_execution_credentials.sql, 0020_actor_replay_step_index.sql, 0021_webhooks.sql, 0022_webhook_follow_ups.sql, 0023_review_indexes.sql, 0024_step_run_tombstone.sql, 0025_inbox_index.sql, 0026_memory.sql, 0027_auth_links_invitations_device.sql, 0028_uploads.sql, 0029_archives_retention.sql, 1001_d1_guard.sql, 1002_execution_token_route.sql, 1003_memory_fts_words.sql, 1004_run_search_words_and_admission_notice.sql, 1005_admission_pool_revision.sql, 1006_object_purge.sql, 1007_archive_version.sql, 1008_supersede_notice.sql, 1009_webhook_log_to_objects.sql, 1010_runbook_source_digests.sql, 1011_run_release.sql, 1012_cron_backoff.sql, 1013_webhook_subscription_deleted.sql, 1014_run_release_backoff.sql, 1015_replay_sweep_backoff.sql, 1016_run_summary_runbook_indexes.sql, 1018_runbook_listing.sql, 1019_notify.sql, 1020_project_slack.sql, 1021_pictures_invitation_name.sql, 1022_project_archived.sql
    • execution_do: 0001_execution.sql, 0002_session_fence.sql, 0003_log_chunk.sql, 0004_import_hold.sql, 0005_import_hold_id.sql, 0006_split_rows.sql
    • org_do: 0001_quotas.sql
    • webhook_do: 0001_delivery_log.sql, 0002_lifecycle.sql
  • Rollback floor: postgres none, d1 none, execution_do none, org_do none, webhook_do none (an install running an older release needs --restore-backup to update, since its code is not safe on this schema).
  • New values (a status, a kind, an enum member): written only once the previous release reads them; see CONTRIBUTING.md. Anything else the previous release cannot read raises the rollback floor.

Operator notes

The first release of The Runbook: the server and web UI (one container
image), the Cloudflare edition, the CLI for Linux and macOS, and the
deployment modules for Docker, Cloud Run-style platforms, GKE and
Cloudflare. Install the CLI with
curl -fsSL https://github.com/angler-ai/the-runbook-app/releases/latest/download/install.sh | sh;
start a server from site/ (Getting started) or docs/install.md.

A new install needs nothing below. The rest is for anyone running a build
from before this release.

Strict assignment and take-over (LANG7)

  • A task may set assignment: strict: only its assignee may claim it
    (agents too, unless the task is actor: agent). A person may take over
    a ready agent step (runbook step claim --take-over, or Take over in the
    web).
  • Update every server instance (or the api Worker) before anyone
    publishes a strict runbook or takes a step over, and do not roll back
    past this release once they have:
    older releases cannot read the new
    run events (StepAssigneeResolved, StepTakenOver), so such runs fail
    to load there until you update again. Nothing is lost. See
    docs/install.md §11 and cloudflare/README.md §0a.

Updating and releases (UPD1)

  • One command updates an install. Docker: deploy/update.sh (backup
    read back in full, health check, rollback; docs/install.md §11).
    Cloudflare: npm run update in cloudflare/ (README §0a). Both install
    attested releases (gh attestation verify, pinned to the release
    workflow and tag) or build a tag from a checkout.
  • /v1/meta reports version and schema; runbook-server --version
    prints the release, the Postgres schema and the rollback floor;
    runbook version shows the CLI's and the server's.
  • A server now refuses a database a newer release migrated
    (postgres.schema_newer_than_code) unless
    RUNBOOK_ALLOW_NEWER_SCHEMA=true, which the update's rollback sets.
    Releases before this one cannot be rolled back to after a newer
    release's migrations without restoring a backup.

Container edition on any platform (HOST1)

  • sslmode now has libpq's meaning, in the server and the sign-in
    service.
    require encrypts the connection but no longer checks the
    database's certificate; verify-full checks the certificate and the host
    name, verify-ca the certificate only. If your DATABASE_URL (or
    DATABASE_URL_DIRECT) says sslmode=require and you want the certificate
    checked, change it to sslmode=verify-full
    , adding
    sslrootcert=<CA file> when your provider's CA is not a public one. The
    server warns at start about each URL that is encrypted but unverified.
  • One port is enough: without RUNBOOK_USERCONTENT_LISTEN_ADDR, user
    content is served on the main port to requests for the user-content host.
    That host must differ from the app's by host name, not only by port.
  • The image follows the platform's PORT (it sets
    RUNBOOK_LISTEN_PORT_FROM_ENV=1); it no longer sets RUNBOOK_LISTEN_ADDR.
  • New: /health/live and /health/ready, graceful shutdown on SIGTERM
    (RUNBOOK_SHUTDOWN_TIMEOUT_SECS, default 8), RUNBOOK_LOG_FORMAT=json,
    RUNBOOK_AUTH_DATABASE_POOL_SIZE, Cloud SQL Unix sockets.
  • Migration 0031 adds runbook.rate_window: rate limits are shared by
    every instance on the database.

See deploy/platforms.md.

Changes in this first release

  • Release: log Docker in to ghcr.io before attesting the image (#7)
  • Skills: easy install everywhere, Claude and ChatGPT, and review fixes (#5)
  • Release: reuse the image build for the binaries; allow 3 hours (#4)
  • Release notes: the 0.1.0 section (#2)
  • Git sync, GKE Google sign-in and SSL policy, CLI step-cap warning; CI fixes (#1)
  • The Runbook: first open-source commit

Assets

  • Image: ghcr.io/angler-ai/runbook:0.1.0 (linux/amd64, linux/arm64).
  • runbook-cli-0.1.0-{linux,macos}-{x86_64,aarch64}.tar.gz, runbook-server-0.1.0-linux-{x86_64,aarch64}.tar.gz.
  • install.sh: installs the CLI for this machine, checked against SHA256SUMS: curl -fsSL https://github.com/angler-ai/the-runbook-app/releases/latest/download/install.sh | sh.
  • therunbook-skill.zip: the therunbook agent skill, to upload to Claude or ChatGPT as a skill: https://github.com/angler-ai/the-runbook-app/releases/latest/download/therunbook-skill.zip.
  • runbook-cloudflare-0.1.0.tar.gz: the Cloudflare edition (built Workers, web UI, migrations, templates).
  • Verify downloads with sha256sum -c SHA256SUMS.