Skip to content

P0 Engineering Hygiene: CI workflow fixes, lockfile, LICENSE, and documentation clarity - #58

Draft
colleenpridemore with Copilot wants to merge 3 commits into
mainfrom
copilot/improve-dac-repository-quality
Draft

P0 Engineering Hygiene: CI workflow fixes, lockfile, LICENSE, and documentation clarity#58
colleenpridemore with Copilot wants to merge 3 commits into
mainfrom
copilot/improve-dac-repository-quality

Conversation

Copilot AI commented Jan 14, 2026

Copy link
Copy Markdown
Contributor

Addresses critical repository hygiene issues: broken CI workflow YAML, missing lockfile, absent LICENSE file, unclear simulated dashboard data, and insufficient documentation about internal-only API integrations.

Changes

CI/CD Workflow

  • Fixed YAML indentation in .github/workflows/aethel-integration-test.yml (lines 27-30)
  • Made Aethel integration tests conditional—skip gracefully on fork PRs without ASI_ONE_API_KEY secret
  • Improved secret handling: use environment variables instead of direct ${{ secrets.* }} expansion in shell conditions

Dependency Management

  • Generated and committed agents/yarn.lock (114 lines, 5.4KB) for reproducible builds

Licensing

  • Added dual-license LICENSE file: MIT base + encouraged sustainability commitments (SUL-1.0, SBL-1.0, EAL-1.0, CGL-1.0)
  • License texts: CC0 1.0 (public domain), Documentation: CC BY 4.0
  • Updated agents/package.json: "license": "MIT AND (SUL-1.0 OR SBL-1.0 OR EAL-1.0 OR CGL-1.0)"
  • Demonstrates sustainability license principles while maintaining OSS compatibility

Dashboard Transparency

  • Added prominent disclaimer banner to compliance dashboard clarifying simulated data (not live metrics)
  • Enhanced JS with 26-line header comment and inline SIMULATED DATA markers in key functions

Dashboard with disclaimer banner

Documentation

  • Added README.md section: @aethel (asi1.ai) integration is internal development/testing only
  • Enhanced agents/docs/AETHEL_INTEGRATION.md with fork contributor guidance—no API key needed to contribute

Example: Conditional CI Test

- name: Check for API key availability
  id: check_api_key
  env:
    API_KEY: ${{ secrets.ASI_ONE_API_KEY }}
  run: |
    if [ -z "$API_KEY" ]; then
      echo "api_key_available=false" >> $GITHUB_OUTPUT
    else
      echo "api_key_available=true" >> $GITHUB_OUTPUT
    fi

- name: Run Aethel integration example
  if: steps.check_api_key.outputs.api_key_available == 'true'
  working-directory: ./agents
  run: npm run example:aethel

Security

CodeQL: 0 alerts. YAML validation: passes.

Original prompt

This section details on the original issue you should resolve

<issue_title>DAC Repository Improvements: Engineering Hygiene, Compliance, and Roadmap Tracking</issue_title>
<issue_description>## Context
This issue tracks high-priority (P0), next-level (P1), and longer-horizon (P2) actions to bring the DAC repository to client-grade production quality, based on technical feedback and additional discussions. It serves as a master tracker for all recommended improvements and reference code locations.

File/Path Highlights:

  • CI/CD & Lockfile: See .github/workflows/aethel-integration-test.yml, agents/.gitignore, npm/yarn lockfile in agents/
  • AI/Agent messaging: Example and implementation files: [agents/examples/aethel-integration.js](agents/examples/aethel-integration. js), [agents/core/AethelAgent.js](agents/core/AethelAgent. js)
  • Custody module & Wallet: Refer to custody/backup/rotation logic and tests in agents/core/ and test practices in agents/tests/
  • Dashboard gap & simulation: Relevant logic and "simulated vs. real" gap: compliance-dashboard.js, compliance-dashboard.html
  • Licensing: Root LICENSE (missing), references in agents/package.json, doc explanations in licenses/
  • Monorepo structure: Current: /, /agents, /bgi-framework, /licenses | Suggested: /docs-site, /packages/agents, /packages/bgi-framework, /docs
  • Jacobian/CFSA: Spec and gap locations: bgi-framework/BGI-Gap-Analysis.md, bgi-framework/BGI-Compliance-Checklist.md
  • Thresholds/Testing: See test recommendations in agents/tests/, compliance calculations/demos in BGI framework HTML/JS files

P0 — Immediate Actions

  • Fix CI workflow YAML indentation (.github/workflows/aethel-integration-test.yml)
  • Commit missing lockfile for chosen package manager in agents/
  • Make API-key integration tests conditional for fork PRs (see examples in agents/examples/aethel-integration. js)
  • Add explicit, repo-wide LICENSE and clarify licensing for code vs docs (see agents/package.json)
  • Clarify simulated vs real dashboard/features in docs and READMEs (compliance-dashboard.js, compliance-dashboard.html)

P1 — Next Iteration

  • Wire protocol messages to agent handlers, update examples (agents/examples/aethel-integration.js, agents/core/AethelAgent. js)
  • Address custody module key/backup/rotation gaps
  • Add unit tests for high-risk/reused components

P2 — Structural and Scaling Improvements

Additional Discussion Points


Relevant Code and Documentation:

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 14, 2026 15:05
…ENSE, dashboard disclaimer, documentation updates

Co-authored-by: colleenpridemore <4281084+colleenpridemore@users.noreply.github.com>
…ling, clarify simulated data

Co-authored-by: colleenpridemore <4281084+colleenpridemore@users.noreply.github.com>
Copilot AI changed the title [WIP] Implement improvements for DAC repository engineering hygiene P0 Engineering Hygiene: CI workflow fixes, lockfile, LICENSE, and documentation clarity Jan 14, 2026
@colleenpridemore

Copy link
Copy Markdown
Contributor

@copilot Wonderful work, GHCP! Thank you!

@colleenpridemore colleenpridemore left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DAC Repository Improvements: Engineering Hygiene, Compliance, and Roadmap Tracking

2 participants