Skip to content

Project review: flowstate has install docs but no release notes #2

Description

@ajbeaver

Generated by Offband issue reporting.

Summary

Project review: flowstate has install docs but no release notes

Routing

  • Repo: offband/FlowState
  • Repo class: public_tool
  • Rule id: project.release_surface
  • Candidate key: project:flowstate:install-docs-without-release-notes
  • Category: project
  • Severity: info
  • Review profile: project
  • Review target: flowstate
  • Labels: offband-report, weekly, needs-owner, project-review
  • Source: project.inventory

Expected

Public tools and apps with install docs should expose release or changelog guidance.

Observed

Install documentation was detected, but release notes or changelog guidance were not.

Why It Matters

Installable projects without release notes make it harder for users to identify stable versions or upgrade risk.

Decision Needed

Add release notes/changelog guidance, mark the repo experimental, or document why releases are intentionally not used.

Policy Source

config/issue-reporting.json: project_inventory.targets.flowstate.repo_class

Evidence

{
  "inventory": {
    "declared_entrypoints": [
      "flow"
    ],
    "docs_files": [
      "LICENSE"
    ],
    "documented_commands": [
      "pipx install git+https:/<redacted-path>",
      "flow init",
      "flow examples install",
      "launchctl setenv FLOW_RUNTIME_TOKEN \"$(flow auth token)\"",
      "flow serve ai-builder",
      "export FLOW_RUNTIME_TOKEN=\"$(flow auth token)\"",
      "launchctl unsetenv FLOW_RUNTIME_TOKEN",
      "flow codex install ai-builder --path <redacted-path>",
      "flow stack manifest ai-builder",
      "flow stack inspect ai-builder",
      "flow resolve --path <redacted-path>",
      "flow stack export ai-builder --format markdown",
      "flow stack export ai-builder --format json"
    ],
    "has_install_docs": true,
    "has_recovery_docs": false,
    "has_release_docs": false,
    "has_security_contact": true,
    "has_test_exception": false,
    "has_usage_docs": false,
    "package_files": [
      "pyproject.toml"
    ],
    "path": "<redacted-path>",
    "readme": true,
    "snapshot": {
      "operation": "api_tarball"
    },
    "systemd_or_deploy_files": [],
    "test_files": [
      "tests/test_auth.py",
      "tests/test_cli.py",
      "tests/test_compose.py",
      "tests/test_server.py",
      "tests/test_store.py"
    ],
    "workflow_files": []
  }
}

Suggested Resolution

Add CHANGELOG/release notes guidance or update the repo class/policy.

Report

  • Report generated: 2026-07-11T20:11:49Z
  • Candidate key: project:flowstate:install-docs-without-release-notes

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions