andygrove opened a new pull request, #1768: URL: https://github.com/apache/datafusion-ballista/pull/1768
# Which issue does this PR close? Closes #. # Rationale for this change The current changelog workflow requires the release engineer to hand-paste the ASF header, the version title line, and the `[Full Changelog](...)` link into every release's notes, because `dev/release/generate-changelog.py` emits only the PR bullet list. `apache/datafusion-comet` has evolved its sibling script to produce a complete, ready-to-commit Markdown file (header, title, commit / contributor summary, categorized PRs, and Credits). Bringing that version into Ballista removes the manual steps documented in `dev/release/README.md`. The single monolithic `CHANGELOG.md` (1646 lines, 24 release sections) also forces every release PR to touch the same large file. Splitting it into one file per release under `docs/source/changelog/` mirrors Comet, makes future release PRs append-only, and surfaces the per-release history in the Sphinx docs. # What changes are included in this PR? - Port `dev/release/generate-changelog.py` to the Comet version, adapted to Ballista's project name and CLI shape (`<tag1> <tag2> <version>`). The new script also resolves refs to SHAs before handing them to the GitHub API, which fixes a latent bug where `HEAD` was resolved by the API to the default branch instead of the caller's local HEAD. - Add a one-shot `dev/release/split-changelog.py` migration script (kept in-tree for reproducibility). - Run the splitter to produce 19 per-version files under `docs/source/changelog/`. Drop the noisy pre-split `apache/arrow-datafusion` umbrella-repo entries (`6.0.0`, `6.0.0-rc0`, `7.0.0`, `7.0.0-rc2`, `7.1.0-rc1`). - Add `docs/source/changelog/index.md` with a Sphinx toctree listing every kept release newest-first. - Add a `Changelog` toctree caption to `docs/source/index.rst` so the per-version pages appear in the rendered site. - Replace the root `CHANGELOG.md` with a short stub pointing at the new location. - Delete the unused `.github_changelog_generator` config (Ruby tool, no longer authoritative). - Update the `### Change Log` section of `dev/release/README.md` to document the single-command flow. # Are there any user-facing changes? The published docs now include a "Changelog" caption in the top-level TOC linking to a separate page per release. The root `CHANGELOG.md` becomes a one-screen stub pointing readers at `docs/source/changelog/index.md`. No code or runtime behavior changes. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
