From 1a06cf1ec649c76b9fb7b10404d2b1f0bb92cab5 Mon Sep 17 00:00:00 2001 From: devkyato <95612413+devkyato@users.noreply.github.com> Date: Wed, 29 Jul 2026 14:32:37 +0800 Subject: [PATCH] Prepare Relay 0.1.1 --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- CHANGELOG.md | 14 +++++++++++ README.md | 4 ++-- docs/releases/0.1.1.md | 34 +++++++++++++++++++++++++++ pyproject.toml | 5 +++- src/relay/__init__.py | 2 +- 6 files changed, 56 insertions(+), 5 deletions(-) create mode 100644 docs/releases/0.1.1.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index b62d2f4..2b3e2d6 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -14,7 +14,7 @@ body: attributes: label: Relay version description: Run `relay --version`. - placeholder: relay 0.1.0 + placeholder: relay 0.1.1 validations: required: true - type: dropdown diff --git a/CHANGELOG.md b/CHANGELOG.md index ae34497..7e8e395 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,19 @@ # Changelog +## 0.1.1 — 2026-07-29 + +- Centralized package versioning in `relay.__version__` so CLI and distribution metadata cannot + drift. +- Completed GitHub community health with issue forms, pull-request guidance, ownership, support, + conduct, security, and roadmap documentation. +- Updated CI to current official GitHub Actions runtimes and retained full Python 3.9–3.14 + validation. +- Fixed strict Mypy compatibility across Python 3.9 and 3.10 environments. +- Added weekly dependency maintenance while preserving the intentional Mypy constraint required + for Python 3.9 analysis. +- Added protected-branch, vulnerability-alert, checksum, and clean-wheel release verification. +- No analyzer rule semantics or command-line interfaces changed in this maintenance release. + ## 0.1.0 — 2026-07-29 - Initial alpha release. diff --git a/README.md b/README.md index d669739..ca32964 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ **Relay shows what blocking code prevents from running.** Relay is a local-first terminal static analyser and conservative timing-impact simulator for -Arduino, ESP32, embedded C++, MicroPython, and Python control programs. Version 0.1.0 is an +Arduino, ESP32, embedded C++, MicroPython, and Python control programs. Version 0.1.x is an alpha: useful for review and teaching, but intentionally cautious and not a safety certification. Analysis never executes, imports, compiles, or uploads the source being inspected. @@ -54,7 +54,7 @@ Estimated consequences (conservative): Exit status is non-zero when a finding reaches `--fail-on` (default: `warning`). Formats are `text`, `json`, `sarif`, and `markdown`. Use `--suggest` or `--suggestions-out relay-suggestions.md` for reviewable patterns; Relay never edits source in -0.1.0 and never claims a suggestion is automatically safe for machinery. +0.1.x and never claims a suggestion is automatically safe for machinery. ## Timing contracts diff --git a/docs/releases/0.1.1.md b/docs/releases/0.1.1.md new file mode 100644 index 0000000..4e429ea --- /dev/null +++ b/docs/releases/0.1.1.md @@ -0,0 +1,34 @@ +# Relay 0.1.1 + +Relay 0.1.1 is a maintenance and release-engineering update to the local-first alpha. + +## Highlights + +- Package metadata and `relay --version` now use one version source. +- GitHub community health is complete with structured issue forms, pull-request guidance, + ownership, support, conduct, security, and roadmap documentation. +- CI uses current official GitHub Actions and validates Python 3.9 through 3.14. +- Strict Mypy remains compatible with the declared Python 3.9 target. +- Dependabot maintains compatible dependencies without reopening an incompatible Mypy update. +- The public repository uses protected `main`, vulnerability alerts, automated security fixes, + release checksums, and clean-wheel smoke tests. + +Analyzer rules, finding severity, report schemas, and CLI behaviour are unchanged from 0.1.0. + +## Compatibility + +- Python: 3.9–3.14 +- Sources: `.ino`, `.cpp`, `.cc`, `.cxx`, `.h`, `.hpp`, `.py`, and `.pyw` +- Operation: local and offline after installation +- Runtime dependency on Python 3.9/3.10 only: `tomli` + +## Install + +```console +python -m pip install relay_lint-0.1.1-py3-none-any.whl +relay --version +relay check examples +``` + +Relay does not execute analysed source and does not guarantee real-time or physical-machine +safety. Verify findings and remediations on the actual target. diff --git a/pyproject.toml b/pyproject.toml index 87b200e..1c6fa08 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "relay-lint" -version = "0.1.0" +dynamic = ["version"] description = "Static timing-impact analysis for embedded and control programs" readme = "README.md" requires-python = ">=3.9" @@ -45,6 +45,9 @@ Documentation = "https://github.com/devkyato/Relay/tree/main/docs" [tool.hatch.build.targets.wheel] packages = ["src/relay"] +[tool.hatch.version] +path = "src/relay/__init__.py" + [tool.hatch.build] exclude = [ "/.release-smoke", diff --git a/src/relay/__init__.py b/src/relay/__init__.py index 896baa9..92cfbe9 100644 --- a/src/relay/__init__.py +++ b/src/relay/__init__.py @@ -12,4 +12,4 @@ "Severity", "analyse_path", ] -__version__ = "0.1.0" +__version__ = "0.1.1"