dotCMS / dotCMS/core

Backfill dev.dotcms.com changelog entries for releases missed by changelog-site-publish-phase

Open
#37,318 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

dotCMS : Build Team : Enablement
Dominant language
Java
Stars
970
Forks
486
Avg merge
3d 33m
Merged PRs (30d)
170

Description

Description

Backfill dev.dotcms.com's changelog entries (Change logs, All Releases, Current Releases pages) for every release version the companion spike identifies as failed/missing, using the documented manual backfill procedure in .github/actions/core-cicd/changelog-publisher/README.md:

uv run changelog-publisher publish --version <version> \
  --notes-file /tmp/site-release-notes.md \
  --docker-image dotcms/dotcms:<version>_<sha> \
  --released-date <yyyy-MM-dd>            # dry-run first
# add --apply once the dry-run looks right

This is a manual, per-version run — there is no automatic backfill (FR-012) — so each affected version needs its own dry-run-then-apply pass. Versions the spike classifies as protectively skipped (human-edited entry) must be left alone.

Blocked by the spike (#37317) that produces the version list.

Acceptance Criteria

  • Every version the spike marks "failed / needs backfill" has been published to dev.dotcms.com via changelog-publisher.
  • Each backfill was dry-run first and verified before --apply.
  • Versions the spike marks "protectively skipped" (human-edited) are left untouched.
  • Post-backfill, dev.dotcms.com's Change logs, All Releases, and Current Releases pages match the corresponding GitHub Release content for every affected version.

Priority

Medium

Additional Context

  • Depends on the spike's findings — don't start until the version list exists.
  • changelog-publisher's human-edit protection (FR-011) applies during backfill too — use --force only to deliberately override a specific hand-edited entry, and only if that's a conscious call, not a default.
  • Parent issue: #37316

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Wait for the version list from spike #37317, then read .github/actions/core-cicd/changelog-publisher/README.md and run the documented dry-run for each failed version. Verify the result before applying, leave protectively skipped entries untouched, and compare dev.dotcms.com's Change logs, All Releases, and Current Releases pages with the corresponding GitHub Releases.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, release
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.