Merge pull request #30 from RAprogramm/new_version

New version

Author: RAprogramm

.github/scripts/gen_readme.sh

@@ -0,0 +1,29 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# Deterministic env for local runs too
+export TZ="${TZ:-UTC}"
+export LC_ALL="${LC_ALL:-C.UTF-8}"
+export NO_COLOR="${NO_COLOR:-1}"
+export CARGO_TERM_COLOR="${CARGO_TERM_COLOR:-never}"
+export SOURCE_DATE_EPOCH="${SOURCE_DATE_EPOCH:-0}"
+
+# Allow forcing toolchain via TOOLCHAIN env (e.g. "+1.78.0")
+TOOLCHAIN="${TOOLCHAIN:-}"
+
+# If you use cargo-readme, prefer it
+if command -v cargo-readme >/dev/null 2>&1; then
+  cargo ${TOOLCHAIN} readme > README.md
+  exit 0
+fi
+
+# If you have your own generator, call it here instead.
+# Examples (uncomment the one you actually use):
+# cargo ${TOOLCHAIN} xtask readme
+# cargo ${TOOLCHAIN} run -p readme-gen
+# cargo ${TOOLCHAIN} run --bin readme_gen
+# cargo ${TOOLCHAIN} readme > README.md
+
+# Fallback: no-op to keep CI green if README is static
+touch README.md
+

.github/workflows/reusable-ci.yml

@@ -11,14 +11,15 @@ jobs:
   ci:
     runs-on: ubuntu-latest
     env:
-      CARGO_LOCKED: "true"   # don't mutate Cargo.lock during CI
+      CARGO_LOCKED: "true"
       CARGO_TERM_COLOR: always
+
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          persist-credentials: true
 
-      # Read MSRV (rust-version) from Cargo.toml
       - name: Read MSRV from Cargo.toml
         id: msrv
         shell: bash
@@ -36,14 +37,12 @@ jobs:
           echo "msrv=${RV}" >> "$GITHUB_OUTPUT"
           echo "Using MSRV: $RV"
 
-      # Install MSRV for clippy/tests/package
       - name: Install Rust (${{ steps.msrv.outputs.msrv }})
         uses: dtolnay/rust-toolchain@v1
         with:
           toolchain: ${{ steps.msrv.outputs.msrv }}
           components: clippy
 
-      # Pin nightly for rustfmt because unstable_features = true in .rustfmt.toml
       - name: Install nightly rustfmt
         uses: dtolnay/rust-toolchain@v1
         with:
@@ -55,7 +54,6 @@ jobs:
         with:
           save-if: ${{ github.ref == 'refs/heads/main' }}
 
-      # Ensure Cargo.lock is present when CARGO_LOCKED=1
       - name: Verify lockfile is committed
         shell: bash
         run: |
@@ -65,6 +63,61 @@ jobs:
             exit 1
           fi
 
+      # ---------- README: regenerate early, normalize, drift handling ----------
+      - name: Regenerate README via build.rs (MSRV, deterministic)
+        shell: bash
+        run: |
+          set -euo pipefail
+          export TZ=UTC
+          export LC_ALL=C.UTF-8
+          export NO_COLOR=1
+          export CARGO_TERM_COLOR=never
+          export SOURCE_DATE_EPOCH=0
+          cargo +${{ steps.msrv.outputs.msrv }} build --workspace -q || cargo +${{ steps.msrv.outputs.msrv }} build -q
+
+      - name: Normalize README (ensure trailing newline) — bash only
+        if: hashFiles('README.md') != ''
+        shell: bash
+        run: |
+          set -euo pipefail
+          if [ -f README.md ] && [ -s README.md ]; then
+            last_byte="$(tail -c1 README.md 2>/dev/null || true)"
+            if [ "$last_byte" != $'\n' ]; then
+              printf '\n' >> README.md
+            fi
+          fi
+
+      - name: README drift report (PR)
+        if: github.event_name == 'pull_request'
+        shell: bash
+        run: |
+          set -euo pipefail
+          if git diff --quiet -- README.md; then
+            echo "README is up to date (PR)."
+          else
+            echo "::warning::README differs on PR. Tests will use regenerated content."
+            git --no-pager diff -- README.md || true
+          fi
+
+      - name: README drift autocommit (main)
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        shell: bash
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          set -euo pipefail
+          if git diff --quiet -- README.md; then
+            echo "README is up to date (main)."
+            exit 0
+          fi
+          echo "Auto-committing refreshed README on main..."
+          git config user.name  "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add README.md
+          git commit -m "chore(readme): auto-refresh [skip ci]"
+          git push
+      # -----------------------------------------------------------------------
+
       - name: Check formatting (nightly rustfmt)
         run: cargo +nightly-2025-08-01 fmt --all -- --check
 
@@ -88,6 +141,17 @@ jobs:
             cargo +${{ steps.msrv.outputs.msrv }} test --workspace --no-fail-fast
           fi
 
+      # На PR возвращаем README к HEAD, чтобы дерево стало чистым перед упаковкой
+      - name: Restore README to HEAD on PR (keep tree clean)
+        if: github.event_name == 'pull_request'
+        shell: bash
+        run: |
+          set -euo pipefail
+          if ! git diff --quiet -- README.md; then
+            echo "Restoring README.md to HEAD to keep tree clean on PR..."
+            git restore --worktree --source=HEAD -- README.md || git checkout -- README.md
+          fi
+
       - name: Ensure tree is clean before package
         shell: bash
         run: |
@@ -100,3 +164,4 @@ jobs:
 
       - name: Package (dry-run)
         run: cargo +${{ steps.msrv.outputs.msrv }} package --locked
+

.hooks/pre-commit

@@ -20,5 +20,20 @@ cargo test --workspace --all-features
 # echo "📦 Validating SQLx prepare..."
 # cargo sqlx prepare --check --workspace
 
+# same deterministic env
+export TZ=UTC
+export LC_ALL=C.UTF-8
+export NO_COLOR=1
+export CARGO_TERM_COLOR=never
+export SOURCE_DATE_EPOCH=0
+
+# Generate
+./.github/scripts/gen_readme.sh
+
+# Stage README if changed
+if ! git diff --quiet -- README.md; then
+  git add README.md
+fi
+
 echo "✅ All checks passed!"
 

CHANGELOG.md

@@ -3,6 +3,35 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+_No changes yet._
+
+## [0.5.0] - 2025-09-23
+
+### Added
+- Re-exported `thiserror::Error` as `masterror::Error`, making it possible to
+  derive domain errors without an extra dependency. The derive supports
+  `#[from]` conversions, validates `#[error(transparent)]` wrappers, and mirrors
+  `thiserror`'s ergonomics.
+- Added `BrowserConsoleError::context()` for retrieving browser-provided
+  diagnostics when console logging fails.
+
+### Changed
+- README generation now pulls from crate metadata via the build script while
+  staying inert during `cargo package`, preventing dirty worktrees in release
+  workflows.
+
+### Documentation
+- Documented deriving custom errors via `masterror::Error` and expanded the
+  browser console section with context-handling guidance.
+- Added a release checklist and described the automated README sync process.
+
+### Tests
+- Added regression tests covering derive behaviour (including `#[from]` and
+  transparent wrappers) and ensuring the README stays in sync with its
+  template.
+- Added a guard test that enforces the `AppResult<_>` alias over raw
+  `Result<_, AppError>` usages within the crate.
+
 ## [0.4.0] - 2025-09-15
 ### Added
 - Optional `frontend` feature:
@@ -113,6 +142,8 @@ All notable changes to this project will be documented in this file.
 - **MSRV:** 1.89
 - **No unsafe:** the crate forbids `unsafe`.
 
+[0.5.0]: https://github.com/RAprogramm/masterror/releases/tag/v0.5.0
+[0.4.0]: https://github.com/RAprogramm/masterror/releases/tag/v0.4.0
 [0.3.5]: https://github.com/RAprogramm/masterror/releases/tag/v0.3.5
 [0.3.4]: https://github.com/RAprogramm/masterror/releases/tag/v0.3.4
 [0.3.3]: https://github.com/RAprogramm/masterror/releases/tag/v0.3.3
@@ -121,5 +152,4 @@ All notable changes to this project will be documented in this file.
 [0.3.0]: https://github.com/RAprogramm/masterror/releases/tag/v0.3.0
 [0.2.1]: https://github.com/RAprogramm/masterror/releases/tag/v0.2.1
 [0.2.0]: https://github.com/RAprogramm/masterror/releases/tag/v0.2.0
-[0.4.0]: https://github.com/RAprogramm/masterror/releases/tag/v0.4.0