Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[1.0.0] - 2025-08-01
Added
- Add project foundation and build infrastructure
- Add OpenAPI 3.1.1 specification and generated Ruby client
- Add helper library and development utilities
- Add comprehensive cross-platform support and documentation
- Add comprehensive Phase 5A content and documentation structure
- Add git-cliff configuration for automated changelog generation
- Integrate git-cliff with VitePress deployment
Documentation
- Add open source legal and community foundation
- Add comprehensive documentation and user guides
- Add development context and ignore AI session files
- Update root files with VitePress frontmatter integration
- Organize documentation style guide and add OpenAPI symlink
- Finalize system integration documentation and UX improvements
- Remove obsolete RELEASE_PROCESS.md (replaced by docs/development/release-process.md)
Fixed
- Resolve dead links in VitePress build
- Reset versions to 1.0.0 for baseline consistency
- Engineer release process to automatically use correct versions
- Stabilize release process and exclude node_modules from linting
- Use correct VitePress paths for changelog links in release notes
MAJOR
- Remove duplicate OpenAPI validation, fix Windows CI/CD permanently
- Migrate from typhoeus to Faraday HTTP client
Miscellaneous Tasks
- Add VitePress documentation infrastructure
- Remove old files after VitePress reorganization
- Remove temporary planning and recovery files
- Ignore VitePress cache directory
- Update generated client files to match OpenAPI v1.0.0
- Update versions to 1.0.1 baseline for testing
Refactor
- Implement DRY structure with symlinks for project documents
Styling
- Add RuboCop configuration for code quality
Testing
- Add comprehensive two-stage testing pattern
Build
- Add development tools and automation scripts
Prepare
- Reset to v0.9.9 and add RuboCop auto-correction for v1.0.0 release
- Reset versions to 0.9.9 for first formal v1.0.0 release
Installation
Ruby Gem
bash
gem install cyber_trackr_live -v 1.0.0
Or add to your Gemfile:
ruby
gem 'cyber_trackr_live', '~> 1.0.0'
OpenAPI Documentation
The interactive API documentation is available at:
Usage Example
ruby
require 'cyber_trackr_live'
# Initialize the client
client = CyberTrackrClient::ApiClient.new
# Use the helper for convenience
helper = CyberTrackrHelper.new
# List all STIGs
stigs = helper.list_stigs
puts "Found #{stigs.size} STIGs"
# Get a complete STIG with all requirements
complete_stig = helper.fetch_complete_stig('Juniper_SRX_Services_Gateway_ALG', '3', '3')
puts "STIG has #{complete_stig[:requirements].size} requirements"