From 135f586430a3a69d205b3b98cac34977b380a704 Mon Sep 17 00:00:00 2001 From: Owais Jamil Date: Wed, 22 Oct 2025 08:37:06 -0500 Subject: [PATCH] docs: added changelog following keepachangelog build: added linting to gh actions with badges --- .github/workflows/lint.yml | 34 +++++++++++++++ .github/workflows/test.yml | 2 +- CHANGELOG.md | 86 ++++++++++++++++++++++++++++++++++++++ README.md | 2 + 4 files changed, 123 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/lint.yml create mode 100644 CHANGELOG.md diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..be439e1 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,34 @@ +name: ESLint + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + lint: + name: Run ESLint on lib + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + with: + fetch-depth: 2 + - uses: pnpm/action-setup@v4 + name: Install pnpm + with: + version: 9 + run_install: false + - name: Install Node.js + uses: actions/setup-node@v3 + with: + node-version: 24 + cache: pnpm + - name: Install dependencies + run: pnpm install --frozen-lockfile + - name: Run ESLint + run: pnpm eslint . + working-directory: lib diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index f263f21..103258f 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: Run tests and upload coverage +name: Tests on: push: diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..56fba3a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,86 @@ +# Changelog + +All notable changes to VoltX will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added + +- Navigation and history API routing for client-side transitions (#6). + +### Changed + +- Refactored the binder and evaluator internals to reduce duplication and clarify runtime responsibilities (#3). +- Split lifecycle and SSR documentation into dedicated guides (#5). + +### Fixed + +- Repaired broken documentation links (#4). +- Stabilized JSR and Deno packaging by restoring CSS assets, removing redundant finalize steps, and keeping builds minified. + +## [v0.4.0] - 2025-10-21 + +### Added + +- Animation and transition directives with runtime support (#1). +- Documentation and runnable examples covering the animation and transition APIs (#2). + +### Fixed + +- Patched the JSR build pipeline to publish without errors. + +## [v0.3.2] - 2025-10-21 + +### Fixed + +- Removed CSS from the JSR build to avoid packaging failures. + +## [v0.3.1] - 2025-10-21 + +### Changed + +- Updated the automated build and publish workflow to streamline releases. + +## [v0.3.0] - 2025-10-21 + +### Added + +- Global state management primitives for sharing data across components. + +### Changed + +- Gzipped and minified production builds to reduce bundle size. +- Introduced shared utilities to eliminate duplicated binding logic. +- Hardened CI by pinning Node.js, adding test and Codecov automation, and enabling npm publishing from tags. +- Refreshed contributor documentation and project badges. + +### Fixed + +- Corrected demo CSS references and documentation stubs. +- Stabilized the publish workflow by fixing pnpm versioning, workflow naming, and tag-trigger configuration. + +## [v0.2.0] - 2025-10-20 + +### Added + +- Reactive attribute handling and event modifiers for richer templating ergonomics. + +## [v0.1.0] - 2025-10-20 + +### Added + +- Core reactivity primitives, binding evaluator, and automatic dependency tracking. +- Effects, actions, async lifecycle hooks, and debugging utilities. +- `volt` developer CLI, build pipeline, and sandboxed expression evaluator. +- Plugin system, control flow directives (`if`, `for`), reactive markup utilities, and SSR/HTTP helpers. +- Initial documentation set covering the runtime overview, reactivity spec, and roadmap. + +[Unreleased]: https://github.com/stormlightlabs/volt/compare/v0.4.0...HEAD +[v0.4.0]: https://github.com/stormlightlabs/volt/compare/v0.3.2...v0.4.0 +[v0.3.2]: https://github.com/stormlightlabs/volt/compare/v0.3.1...v0.3.2 +[v0.3.1]: https://github.com/stormlightlabs/volt/compare/v0.3.0...v0.3.1 +[v0.3.0]: https://github.com/stormlightlabs/volt/compare/v0.2.0...v0.3.0 +[v0.2.0]: https://github.com/stormlightlabs/volt/compare/v0.1.0...v0.2.0 +[v0.1.0]: https://github.com/stormlightlabs/volt/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 4705117..f044942 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![JSR](https://jsr.io/badges/@voltx/core)](https://jsr.io/@voltx/core) ![NPM Version](https://img.shields.io/npm/v/voltx.js?logo=npm) +![Status - Test](https://github.com/stormlightlabs/volt/actions/workflows/test.yml/badge.svg) +![Status - Lint](https://github.com/stormlightlabs/volt/actions/workflows/lint.yml/badge.svg) > ⚠️ **Pre-release Software**: VoltX.js remains in active development. Expect breaking changes until v1.0 and evaluate before using in production. -- 2.51.2