From 01968ac1c7625357527616306d18a9bc90f865ef Mon Sep 17 00:00:00 2001 From: jepegit Date: Sun, 19 Apr 2026 19:14:03 +0200 Subject: [PATCH 1/2] Add HISTORY.md to document release history and link from README.md Created a new `HISTORY.md` file to track notable changes and releases for the issue-flow project, following a loose "Keep a Changelog" format. Added sections for each release from v0.1.0 to v0.2.2, along with an "Unreleased" section for ongoing changes. Updated `README.md` to include a "Changelog" section linking to the new history file. --- .../01-current-issues/issue14_original.md | 7 +++ .../01-current-issues/issue14_status.md | 40 ++++++++++++ HISTORY.md | 61 +++++++++++++++++++ README.md | 4 ++ 4 files changed, 112 insertions(+) create mode 100644 .issueflows/01-current-issues/issue14_original.md create mode 100644 .issueflows/01-current-issues/issue14_status.md create mode 100644 HISTORY.md diff --git a/.issueflows/01-current-issues/issue14_original.md b/.issueflows/01-current-issues/issue14_original.md new file mode 100644 index 0000000..7b5c650 --- /dev/null +++ b/.issueflows/01-current-issues/issue14_original.md @@ -0,0 +1,7 @@ +# Issue #14: Add a history file + +Source: https://github.com/jepegit/issue-flow/issues/14 + +## Original issue text + +The issue-flow repository does not contain any HISTORY.md file. We should have that. diff --git a/.issueflows/01-current-issues/issue14_status.md b/.issueflows/01-current-issues/issue14_status.md new file mode 100644 index 0000000..5977304 --- /dev/null +++ b/.issueflows/01-current-issues/issue14_status.md @@ -0,0 +1,40 @@ +# Issue #14 status: Add a history file + +Source: https://github.com/jepegit/issue-flow/issues/14 + +## Summary + +The repo had no release history file. Added a top-level `HISTORY.md` that +documents every published release (v0.1.0 through v0.2.2) plus an +`## [Unreleased]` section for changes landed on `main` since v0.2.2 +(PRs #35, #36, #37, #38). Linked it from `README.md` under a new +"Changelog" section. + +## What was done + +- Created `HISTORY.md` at the repo root. + - Loose "Keep a Changelog" format. + - Sections for every released tag: `0.2.2`, `0.2.1.post2`, `0.2.1.post1`, + `0.2.1`, `0.2.0`, `0.1.4`, `0.1.3`, `0.1.2`, `0.1.1`, `0.1.0`. + - `## [Unreleased]` section populated with work merged after v0.2.2 + (`.env` scaffolding, `ISSUEFLOW_AGENT_DIR` rename, `/issue-close` + improvements, branch & folder hygiene). + - Noted that pre-0.2.2 entries are reconstructed from git log / + PR titles and link back to the GitHub release page. +- Added a short "Changelog" section in `README.md` pointing to + `HISTORY.md`. + +## Files changed + +- `HISTORY.md` (new) +- `README.md` (added "Changelog" section linking to `HISTORY.md`) + +## Remaining work + +- None — the issue only asks for a HISTORY file to exist. Future version + bumps via `/issue-close` should move entries from `## [Unreleased]` + into a new versioned section. + +## Status + +- [x] Done diff --git a/HISTORY.md b/HISTORY.md new file mode 100644 index 0000000..17a05c6 --- /dev/null +++ b/HISTORY.md @@ -0,0 +1,61 @@ +# History + +This file tracks notable changes to **issue-flow** per release. + +Format is loosely based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). +Release tags live on GitHub: . +Pre-0.2.2 entries are reconstructed from git history and PR titles and may be less precise +than the GitHub release notes they link to. + +## [Unreleased] + +- `issue-flow init` now creates or extends a project `.env` with `ISSUEFLOW_*` hints (#35). +- Rename `ISSUEFLOW_CURSOR_DIR` to the more tool-agnostic `ISSUEFLOW_AGENT_DIR` (#36). +- `/issue-close` flags unrelated uncommitted changes and reminds about the issue branch after the PR is opened (#37). +- Branch and folder hygiene added to `/issue-init`, `/issue-start`, and `/issue-close`: non-destructive preflight reporting of current branch, ahead/behind counts, and working-tree state; automatic sweep of stale entries in `.issueflows/01-current-issues/` based on the `- [x] Done` marker in status files (#38, addresses #31). + +## [0.2.2] - 2026-04-17 + +- `issue-flow init` now creates or extends `.env` with `ISSUEFLOW_*` hints so downstream tools pick up the same config (#34). +- Cursor Agent Skills (`issueflow-issue-init`, `issueflow-issue-start`, `issueflow-issue-close`, `issueflow-version-bump`) are scaffolded into `.cursor/skills/` by `init` / `update` (#28). +- `/issue-close` gained an optional `uv version --bump` step and a local scaffold script so contributors can preview template changes without reinstalling (#27, #30). +- `issue-flow update` now handles already-initialized projects more safely (#29). + +## [0.2.1.post2] - 2026-04-16 + +- Packaging / metadata fix-up (no user-facing changes). + +## [0.2.1.post1] - 2026-04-16 + +- Packaging / metadata fix-up (no user-facing changes). + +## [0.2.1] - 2026-04-16 + +- Optional version-bump step in `/issue-close` (first cut) and 0.2.1 release plumbing (#11). +- Streamlined `/issue-init` guidance for issue body text and newline handling (#9). + +## [0.2.0] - 2026-04-15 + +- Added Agent Skills scaffold for `issue-flow init` / `update` so Cursor can invoke the workflow on demand via `/issueflow-issue-*` and `@issueflow-version-bump` (#8). + +## [0.1.4] - 2026-04-15 + +- New `issue-flow update` command and safer re-init messaging when a scaffold already exists (#5). +- Version bump plumbing (#6). + +## [0.1.3] - 2026-04-15 + +- Packaging / metadata fix-up (no user-facing changes). + +## [0.1.2] - 2026-04-15 + +- `/issue-init` can be run with no arguments: when the current branch matches `-`, it offers to use issue `#N` (#3). + +## [0.1.1] - 2026-04-04 + +- Ensure `.gitkeep` files are created in every `.issueflows/` subdirectory so empty folders are preserved in git. +- Project metadata polish and initial CI workflow for PyPI publishing. + +## [0.1.0] - 2026-04-03 + +- Initial release: `issue-flow` CLI with `init`, Jinja2 templates for `/issue-init`, `/issue-start`, and `/issue-close` slash commands, and the `.issueflows/` directory scaffold. diff --git a/README.md b/README.md index ca72b92..899bed4 100644 --- a/README.md +++ b/README.md @@ -120,6 +120,10 @@ uv run pytest uv run ruff check src/ tests/ ``` +## Changelog + +See [HISTORY.md](HISTORY.md) for release notes. + ## Future plans - **Multi-tool support** — generate config for other AI coding tools (Claude Code, Windsurf, etc.) in addition to Cursor. From 4014fb32422e71bcae63dd43262d379cc26daad9 Mon Sep 17 00:00:00 2001 From: jepegit Date: Sun, 19 Apr 2026 19:21:08 +0200 Subject: [PATCH 2/2] Archive issue #14 files to solved-issues Moves issue14_original.md and issue14_status.md from .issueflows/01-current-issues/ to .issueflows/03-solved-issues/ now that the HISTORY.md work is complete (status marked Done). Made-with: Cursor --- .../{01-current-issues => 03-solved-issues}/issue14_original.md | 0 .../{01-current-issues => 03-solved-issues}/issue14_status.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename .issueflows/{01-current-issues => 03-solved-issues}/issue14_original.md (100%) rename .issueflows/{01-current-issues => 03-solved-issues}/issue14_status.md (100%) diff --git a/.issueflows/01-current-issues/issue14_original.md b/.issueflows/03-solved-issues/issue14_original.md similarity index 100% rename from .issueflows/01-current-issues/issue14_original.md rename to .issueflows/03-solved-issues/issue14_original.md diff --git a/.issueflows/01-current-issues/issue14_status.md b/.issueflows/03-solved-issues/issue14_status.md similarity index 100% rename from .issueflows/01-current-issues/issue14_status.md rename to .issueflows/03-solved-issues/issue14_status.md