github-starred/cs249r_book
2
0
Fork 0
mirror of https://github.com/harvard-edge/cs249r_book.git synced 2026-05-07 10:08:50 -05:00
Code Issues 85 Packages Projects Releases 24 Wiki Activity

Resolve Duplication in Changelog Generation (Live Workflow vs Local QMD Rendering) #412

New Issue
Closed
opened 2026-03-22 15:38:59 -05:00 by GiteaMirror · 1 comment
GiteaMirror commented 2026-03-22 15:38:59 -05:00
Owner
Copy Link

Originally created by @profvjreddi on GitHub (Aug 3, 2025).

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). 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-03-22 15:38:59 -05:00
GiteaMirror commented 2026-03-22 15:39:00 -05:00
Author
Owner
Copy Link

@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
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
area: book
area: collabs
area: kits
area: socratiq
area: tinytorch
area: tools
area: website
bug
dependencies
format: epub
format: pdf
link-health
link-rot
priority-high
pull-request
Mirrored from GitHub Pull Request
 staffml
type: bug
type: citation
type: code
type: errata
type: improvement
type: new
type: question
vault-sli
No Label area: tools
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/cs249r_book#412
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?