Skip to content

Backport the CHANGELOG to dev, with the dev-only entries - #185

Merged
antonio-leblanc merged 2 commits into
forefireAPI:devfrom
HugoFara:doc-changelog-dev
Aug 13, 2026
Merged

Backport the CHANGELOG to dev, with the dev-only entries#185
antonio-leblanc merged 2 commits into
forefireAPI:devfrom
HugoFara:doc-changelog-dev

Conversation

@HugoFara

Copy link
Copy Markdown
Collaborator

Backport of #184 to dev, plus the entries and options that only exist here.

The first commit is #184 cherry-picked unchanged. The second adds what master does not have.

The [Unreleased] section

#184 lists #154 and #155, because that is all master has. This adds the ten pull requests merged into dev since v2.5.0: the unit suite (#156), the moisture invariants (#158), the sanitizer job (#180), the HTTP characterisation tests (#174), the threading reproduction (#176), runANN (#183), and the double-free and shared-state fixes (#157, #177, #178).

The two files differ by additions only — 45 entry lines and 10 link definitions, zero removals:

$ git diff doc-changelog-master:CHANGELOG.md doc-changelog-dev:CHANGELOG.md | grep -c '^-[^-]'
0

So when dev is next merged into master, this file supersedes that one with nothing to resolve. That is why the [Unreleased] heading text is identical on both branches rather than each describing its own branch — a one-line difference there would have conflicted on every sync.

Two things our own work made stale

Verification

  • The cherry-pick applied cleanly; no conflict resolution was involved.
  • Every link reference in the file resolves — no [#nnn] without a definition, no duplicate definitions.

This pull request, including its code changes and this description, was generated by Claude Opus 5, and reviewed manually before submitting.

The repository has seven tags and six GitHub releases, and no file that
tells a user what changed between them. `pip install forefire` makes that
worse: someone pinning a version has the release notes on GitHub and
nothing in the tree.
CHANGELOG.md reconstructs every release from the release notes and the
commit history. Claims that could be checked were checked against the
tags: listenHTTP and RothermelAndrews2018 are absent at v1.2 and present
at v2.0, the geojson dump mode is absent at v1.1.10.
[Unreleased] lists only what is on this branch, forefireAPI#154 and forefireAPI#155. The dev
branch carries a longer list in its own copy, which supersedes this one
when dev is merged.
CONTRIBUTING.md now asks for an entry, so the file stays current instead
of being reconstructed again in a year. Its link to a testing page
pointed at a Read the Docs URL that has never existed; it points at
TESTING.md, which nothing in the repository linked to.
(cherry picked from commit cc7e1789c66432aec56673993c3b6e198e0525a0)
The CHANGELOG landed on master carries only forefireAPI#154 and forefireAPI#155 under
[Unreleased], because that is all master has. This adds the ten pull
requests merged into dev since: the unit suite, the moisture invariants,
the sanitizer job, the HTTP characterisation tests, the threading
reproduction, and the shared-state and double-free fixes.
Two things went stale on dev while that work landed, both of them ours.
The README's CMake option table stopped at six options; forefireAPI#156 and forefireAPI#180
added FOREFIRE_BUILD_TESTS, FOREFIRE_ENABLE_WARNINGS,
FOREFIRE_WARNINGS_AS_ERRORS and FOREFIRE_SANITIZE. And CONTRIBUTING told
contributors to run `cd tests && bash run.bash`, which does not reach the
C++ unit tests at all; ctest does.
@HugoFara

Copy link
Copy Markdown
CollaboratorAuthor

#184 should be merged first, holding on this one.

@antonio-leblancantonio-leblanc left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-only backport, verified locally against master's #184/#186 — no conflicts, cherry-picks apply cleanly.

@antonio-leblanc
antonio-leblanc merged commit 3c688bc into forefireAPI:devAug 13, 2026
4 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@HugoFara@antonio-leblanc