Skip to content

changelog(prepare-artifact): treat empty existing-filename as unset #3314

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cotti merged 1 commit into from
May 13, 2026
Merged

changelog(prepare-artifact): treat empty existing-filename as unset #3314

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/services/Elastic.Changelog/Evaluation/ChangelogPrepareArtifactService.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,17 @@ public async Task<bool> PrepareArtifact(IDiagnosticsCollector collector, Prepare

if (sourceYaml != null)
{
changelogFilename = input.ExistingChangelogFilename != null
? _fileSystem.Path.GetFileName(input.ExistingChangelogFilename)
// Treat empty as unset: CLI parsers (e.g. Argh) forward `--flag ""`
// as the empty string instead of null. An empty filename here would
// make Path.Combine(OutputDir, "") collapse to OutputDir itself and
// turn the artifact write into a write against the directory path,
// which fails with EACCES on Linux.
var hasExistingFilename = !string.IsNullOrEmpty(input.ExistingChangelogFilename);
changelogFilename = hasExistingFilename
? _fileSystem.Path.GetFileName(input.ExistingChangelogFilename!)
: _fileSystem.Path.GetFileName(sourceYaml);

if (input.ExistingChangelogFilename != null)
if (hasExistingFilename)
_logger.LogInformation("Reusing existing filename {Filename} for stable path on branch", changelogFilename);

var destYaml = _fileSystem.Path.Combine(input.OutputDir, changelogFilename);
Expand Down
20 changes: 20 additions & 0 deletions tests/Elastic.Changelog.Tests/Evaluation/ChangelogPrepareArtifactServiceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,26 @@ public async Task PrepareArtifact_ExistingFilename_RenamesStagingFileToMatch()
metadata.ChangelogFilename.Should().Be("1735689600-old-title.yaml");
}

[Fact]
public async Task PrepareArtifact_EmptyExistingFilename_FallsBackToStagingFilename()
{
// Regression: CLI parsers (Argh) forward `--existing-changelog-filename ""`
// as the empty string instead of null. An empty filename used to make
// Path.Combine(OutputDir, "") collapse to OutputDir itself and write the
// artifact YAML at the directory path → EACCES on Linux.
await SetupStagingYaml("1735700000-new-title.yaml");
await SetupConfig();
var service = CreateService();
var args = DefaultArgs() with { ExistingChangelogFilename = string.Empty };

var result = await service.PrepareArtifact(Collector, args, CancellationToken.None);

result.Should().BeTrue();
FileSystem.File.Exists(Path.Join(OutputDir, "1735700000-new-title.yaml")).Should().BeTrue();
var metadata = ReadMetadata();
metadata.ChangelogFilename.Should().Be("1735700000-new-title.yaml");
}

[Fact]
public async Task PrepareArtifact_MissingStagingYaml_StatusError()
{
Expand Down
Loading