Skip to content

Commit d6ed03f

Browse files
committed
chore(release): finalize v0.8.0 - analysis, integrations, and AI-ready interfaces
1 parent a93974d commit d6ed03f

19 files changed

+1308
-20
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
66

77
## [Unreleased]
88

9+
## [0.8.0] - 2026-03-29
10+
11+
- Introduced `orgscript analyze <file>` for deterministic structural analysis (block counts, metrics, and complexity hints).
12+
- Added `orgscript export context <file>` to package logic for AI-ready workflows (Bundled model, analysis, and summaries).
13+
- Published integration recipes for GitHub Actions and pre-commit hooks under `docs/integrations/`.
14+
- Upgraded documentation site builder to highlight the "Source-to-Docs" flow and unified artifacts.
15+
- Expanded the showcase with a high-quality "Incident Escalation" trust case.
16+
- Stabilized CLI output for analysis and context exports.
17+
918
## [0.7.0] - 2026-03-29
1019

1120
- Enhanced CLI for professional distribution: added `--version` and improved help text.

ROADMAP.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,15 @@ Theme: **Packaging, Distribution, and Trust**
6262
- **Documentation Site**: Automated static documentation on GitHub Pages.
6363
- **Trust & Showcase**: Complex business logic scenarios and integration examples.
6464

65+
## v0.8 (Completed)
66+
67+
Theme: **Analysis, Integrations, and AI-Ready Interfaces**
68+
69+
- **Deterministic Analysis**: New `orgscript analyze` command for structural metrics.
70+
- **AI-Ready Context**: Stable context export format for LLM workflows.
71+
- **Tooling Hooks**: Recipes for CI/CD and pre-commit integrations.
72+
- **Docs site upgrade**: Improved site-site navigation and showcase grouping.
73+
6574
## Later
6675

6776
- Ecosystem integrations
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Integration: GitHub Actions
2+
3+
You can use OrgScript in your CI pipeline to ensure all logic models in your repository remain valid, lint-clean, and canonically formatted.
4+
5+
## Basic Validation Workflow
6+
7+
Create a file named `.github/workflows/orgscript-check.yml`:
8+
9+
```yaml
10+
name: OrgScript Logic Check
11+
12+
on:
13+
push:
14+
branches: [ main ]
15+
pull_request:
16+
branches: [ main ]
17+
18+
jobs:
19+
check:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- uses: actions/checkout@v4
23+
24+
- name: Set up Node.js
25+
uses: actions/setup-node@v4
26+
with:
27+
node-version: '20'
28+
29+
- name: Install OrgScript
30+
run: npm install -g orgscript
31+
32+
- name: Run OrgScript Check
33+
run: |
34+
# Check all .orgs files in the repository
35+
find . -name "*.orgs" -exec orgscript check {} +
36+
```
37+
38+
## AI Search/Index Ingest Workflow
39+
40+
To feed your organization's logic into an LLM or vector database periodically:
41+
42+
```yaml
43+
index-logic:
44+
runs-on: ubuntu-latest
45+
steps:
46+
- uses: actions/checkout@v4
47+
- name: Install OrgScript
48+
run: npm install -g orgscript
49+
- name: Generate AI Context
50+
run: |
51+
mkdir -p logic-context
52+
for file in $(find examples -name "*.orgs"); do
53+
name=$(basename "$file" .orgs)
54+
orgscript export context "$file" > "logic-context/${name}.json"
55+
done
56+
# Then upload logic-context as artifact or push to your index
57+
```

docs/integrations/pre-commit.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Integration: Pre-commit Hooks
2+
3+
Ensure no invalid or non-canonical OrgScript logic enters your repository.
4+
5+
## Using Husky
6+
7+
If you use [Husky](https://typicode.github.io/husky/) in your project:
8+
9+
1. **Install Husky:**
10+
```bash
11+
npm install husky --save-dev
12+
npx husky init
13+
```
14+
15+
2. **Add pre-commit hook:**
16+
```bash
17+
echo "find . -name '*.orgs' -exec orgscript check {} +" > .husky/pre-commit
18+
chmod +x .husky/pre-commit
19+
```
20+
21+
## Using a Shell Script
22+
23+
For a barebones git pre-commit hook, add this to `.git/hooks/pre-commit`:
24+
25+
```bash
26+
#!/bin/sh
27+
28+
# Staged files (.orgs only)
29+
STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep ".orgs$")
30+
31+
if [ -z "$STAGED_FILES" ]; then
32+
exit 0
33+
fi
34+
35+
echo "Running OrgScript check on staged files..."
36+
37+
for file in $STAGED_FILES; do
38+
orgscript check "$file"
39+
if [ $? -ne 0 ]; then
40+
echo "OrgScript check failed for $file. Aborting commit."
41+
exit 1
42+
fi
43+
done
44+
45+
exit 0
46+
```

docs/releases/v0.8.0.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# OrgScript v0.8.0
2+
3+
OrgScript v0.8.0 is the **Analysis, Integrations, and AI-Ready Interfaces** release.
4+
5+
This release matures OrgScript’s capability to be used as a structured source of truth for downstream systems. By introducing deterministic analysis and stable context exports, we make OrgScript documents significantly more useful for both automated CI/CD pipelines and modern AI/Agent workflows.
6+
7+
## Highlights
8+
9+
### Deterministic Analysis
10+
- **`orgscript analyze <file>`**: A new command for structural inspection without LLM dependency.
11+
- **Structural Metrics**: Reports block counts, trigger inventories, state/transition counts, and role capabilities.
12+
- **Complexity Hints**: Provides insights into the branching and statement volume of your logic.
13+
14+
### AI-Ready Context
15+
- **`orgscript export context <file>`**: Packages the entire logic model, diagnostics, and summaries into a single machine-friendly JSON format.
16+
- **Ingest Optimization**: Designed to be the standard context bundle for feeding OrgScript logic into LLM agents or vector indexes.
17+
18+
### Integration Recipes
19+
- **GitHub Actions**: Added production-ready workflow templates for CI quality gates.
20+
- **Post-Commit Hooks**: Provide examples for Husky and native git hooks to ensure logic consistency.
21+
- **Repository Hooks**: Documentation on how to integrate OrgScript into existing engineering workflows.
22+
23+
### Showcase Upgrade
24+
- **Doc Site Builder v2**: Upgraded `scripts/build-docs.js` to create a more comprehensive preview of all artifacts (Source, Analysis, Summary, Diagram).
25+
- **Incident Escalation SLA**: A new high-quality example demonstrating time-based policies and operational handling in high-trust environments.
26+
27+
## Verification
28+
29+
Confirmed on the current release state:
30+
- All tests passed (`npm test`).
31+
- Analyzed hero examples with success.
32+
- Exported AI-ready context for cross-system verification.
33+
34+
## Project Evolution
35+
36+
v0.8.0 establishes OrgScript as a reliable, machine-readable interface. While v0.7.0 was about packaging, v0.8.0 is about **utility**—ensuring that every line of OrgScript code provides immediate, structured value for both human stakeholders and automated agents.

docs/roadmaps/v0.8.0.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# OrgScript v0.8.0 Roadmap [COMPLETED]
2+
3+
Status: Completed
4+
Theme: **Analysis, Integrations, and AI-Ready Interfaces**
5+
6+
The goal of v0.8.0 is to make OrgScript easier to inspect, analyze, and integrate into downstream tooling and AI workflows. This release focuses on stable machine-readable outputs and deterministic analysis rather than language expansion.
7+
8+
## Goals
9+
10+
- Introduce a deterministic analysis layer for structural inspection.
11+
- Provide a stable context export format for AI/Agent ingest.
12+
- Establish practical integration recipes for CI/CD and repository workflows.
13+
- Mature the documentation site and showcase value.
14+
15+
## Work Packages
16+
17+
### WP1: Deterministic Analysis Command
18+
- Implement `orgscript analyze <file>` (and `--json`).
19+
- Report structural metrics: block counts, triggers, states, transitions, role capabilities.
20+
- Add "Complexity Hints" based on AST depth and branch counts.
21+
22+
### WP2: AI-Ready Context Export
23+
- Implement `orgscript export context <file>`.
24+
- Create a unified context package containing the canonical model, diagnostics, and summaries.
25+
- Ensure the format is optimized for reliable AI/LLM interpretation.
26+
27+
### WP3: Integration Recipes & Tooling Hooks
28+
- Create documentation for GitHub Actions integration.
29+
- Provide pre-commit/pre-push hook examples.
30+
- Document CI/CD pipeline patterns for OrgScript logic governance.
31+
32+
### WP4: Documentation Site & Showcase Upgrade
33+
- Refine the generated docs site (`scripts/build-docs.js`).
34+
- Improve navigation and visual grouping of artifacts (Source vs. Summary vs. Diagram).
35+
- Highlight hero examples more effectively.
36+
37+
### WP5: Real-World Trust Cases
38+
- Add high-quality examples: Finance Approval and Incident Escalation.
39+
- Ensure all showcases exercise multiple OrgScript blocks (`process`, `rule`, `stateflow`).
40+
41+
## Non-Goals
42+
- Adding new language keywords or block types.
43+
- Free-form AI text generation or speculative recommendations.
44+
- SaaS or cloud features.

editors/vscode/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "orgscript-vscode",
33
"displayName": "OrgScript",
44
"description": "Minimal VS Code language support for OrgScript (.orgs) files.",
5-
"version": "0.7.0",
5+
"version": "0.8.0",
66
"publisher": "dkfuh",
77
"repository": {
88
"type": "git",

examples/incident-escalation.orgs

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
stateflow IncidentLifecycle
2+
3+
states
4+
open
5+
triaged
6+
investigating
7+
mitigated
8+
resolved
9+
closed
10+
11+
transitions
12+
open -> triaged
13+
triaged -> investigating
14+
triaged -> mitigated
15+
investigating -> mitigated
16+
mitigated -> resolved
17+
resolved -> closed
18+
19+
role OnCallEngineer
20+
21+
can
22+
triage incident
23+
assign responder
24+
update status
25+
resolve incident
26+
27+
role IncidentManager
28+
29+
can
30+
escalate incident
31+
declare major incident
32+
notify stakeholders
33+
34+
policy EscalationPolicy
35+
36+
when incident.severity = "high" and incident.status = "open"
37+
then
38+
require triage_sla
39+
notify on_call_manager with "SLA Warning: High severity incident untriaged"
40+
41+
when incident.status = "investigating"
42+
then
43+
require regular_status_updates
44+
45+
process IncidentHandling
46+
47+
when system.alert_received
48+
49+
create incident
50+
assign incident.severity = "medium"
51+
transition incident.status to "open"
52+
53+
if alert.source = "critical_infrastructure" then
54+
assign incident.severity = "high"
55+
notify on_call_team with "Critical alert detected"
56+
57+
if incident.status = "triaged" then
58+
assign incident.primary_responder = "on_call_engineer"
59+
transition incident.status to "investigating"
60+
61+
else
62+
notify incident_manager with "Incident requiring triage"

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "orgscript",
3-
"version": "0.7.0",
3+
"version": "0.8.0",
44
"description": "A human-readable, AI-friendly description language for business logic and operational systems.",
55
"license": "Apache-2.0",
66
"private": true,

0 commit comments

Comments
 (0)