Skip to content

Handle missing changelog (sections) during pack - #433

Merged
dennisdoomen merged 2 commits into
Fallout-build:mainfrom
dennisdoomen:pack-analysis
Jun 27, 2026
Merged

Handle missing changelog (sections) during pack#433
dennisdoomen merged 2 commits into
Fallout-build:mainfrom
dennisdoomen:pack-analysis

Conversation

@dennisdoomen

@dennisdoomendennisdoomen commented Jun 26, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Make pack resilient when no changelog release sections are available.
  • Add regression coverage for a missing changelog file.
  • Clarify that the build entrypoint project is intentionally excluded from solution builds.

Changes

  • Handle missing changelog sections during pack
    • Return empty release notes when the changelog file is missing or contains no release sections, avoiding the pack-time exception.
  • Adjust solution build settings
    • Keep the solution file aligned with the current build configuration for this PR branch.
    • The build entrypoint project (build/_build.csproj) is intentionally marked as not built in the solution so it is exercised via the build entrypoint (./build.ps1 / ./build.sh) rather than as a normal solution build target.

Combined effect

  • Pack no longer fails just because the changelog is absent or empty, and the PR history is split into focused commits.

Validation

  • dotnet test tests/Fallout.Common.Tests/Fallout.Common.Tests.csproj --filter ChangelogTasksTest

Note The failing build was caused by #375, but wasn't caught by GHA as that one skips changes to doc files.

@dennisdoomen
dennisdoomen requested a review from a team as a code ownerJune 26, 2026 06:48
@dennisdoomen
dennisdoomenforce-pushed the pack-analysis branch 3 times, most recently from 8920223 to 093cbdeCompareJune 26, 2026 06:56
@dennisdoomendennisdoomen added target/vCurrent Targets the current version bug Something isn't working labels Jun 26, 2026
@dennisdoomendennisdoomen changed the title Handle missing changelog sections during packHandle missing changelog (sections) during packJun 26, 2026
Comment threadsrc/Fallout.Common/ChangeLog/ChangeLogTasks.cs

@ChrisonSimtianChrisonSimtian 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.

lgtm, I'd throw a warning ala

Warning: You called the Changelog Task but we couldnt find a changelog.md

And then we can either create one (I'd rather not) or the user at least sees why we didnt write anything

dennisdoomenand others added 2 commits June 27, 2026 08:10
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dennisdoomen

Copy link
Copy Markdown
CollaboratorAuthor

And then we can either create one (I'd rather not) or the user at least sees why we didnt write anything

See my remark about logging.

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bugSomething isn't workingtarget/vCurrentTargets the current version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dennisdoomen@ChrisonSimtian