[GH-ISSUE #917] Resolve Duplication in Changelog Generation (Live Workflow vs Local QMD Rendering) #1628

New Issue

GiteaMirror · 2026-04-11T07:59:12-05:00

GiteaMirror commented

2026-04-11 07:59:12 -05:00

Originally created by @profvjreddi on GitHub (Aug 3, 2025).
Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/917

Currently, the changelog for the book is generated automatically through the 'publish live' GitHub workflow. However, the book also renders changelog content into Quarta QMD, which requires the changelog to be available locally beforehand. This creates duplication between the live publishing workflow (where the changelog is regenerated) and the offline/local generation that also needs to happen.

We need to resolve this duplication so that the changelog is generated in a single place and is accessible for both the live workflow and the local QMD rendering process.

Proposed Solution:

Investigate whether changelog generation can be unified or made available as a shared artifact between both workflows.
Update relevant scripts, documentation, and workflows to ensure changelog is consistently available where needed.

Additional context:

The duplication currently introduces unnecessary complexity and possible version mismatches.
The solution should work well for both automated publishing and local book builds.

Originally created by @profvjreddi on GitHub (Aug 3, 2025). Original GitHub issue: https://github.com/harvard-edge/cs249r_book/issues/917 Currently, the changelog for the book is generated automatically through the 'publish live' GitHub workflow. However, the book also renders changelog content into Quarta QMD, which requires the changelog to be available locally beforehand. This creates duplication between the live publishing workflow (where the changelog is regenerated) and the offline/local generation that also needs to happen. We need to resolve this duplication so that the changelog is generated in a single place and is accessible for both the live workflow and the local QMD rendering process. **Proposed Solution:** - Investigate whether changelog generation can be unified or made available as a shared artifact between both workflows. - Update relevant scripts, documentation, and workflows to ensure changelog is consistently available where needed. **Additional context:** - The duplication currently introduces unnecessary complexity and possible version mismatches. - The solution should work well for both automated publishing and local book builds.

GiteaMirror added the area: tools label 2026-04-11 07:59:12 -05:00

GiteaMirror closed this issue

2026-04-11 07:59:12 -05:00

GiteaMirror commented

2026-04-11 07:59:13 -05:00

@profvjreddi commented on GitHub (Aug 23, 2025):

Resolved in d04b718b and related commits: improved changelog generation

@profvjreddi commented on GitHub (Aug 23, 2025): Resolved in d04b718b and related commits: improved changelog generation

GiteaMirror referenced this issue

2026-05-03 01:29:40 -05:00

[PR #1628] fix(labs): use ESP32 SRAM capacity field in lab 07 #9234

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/cs249r_book#1628