Remove : from filenames (#143)

Author: endorama

changelog/fragments/1687169387-fragment-filename-sanitize.yaml

@@ -0,0 +1,32 @@
+# Kind can be one of:
+# - breaking-change: a change to previously-documented behavior
+# - deprecation: functionality that is being removed in a later release
+# - bug-fix: fixes a problem in a previous version
+# - enhancement: extends functionality but does not break or fix existing behavior
+# - feature: new functionality
+# - known-issue: problems that we are aware of in a given version
+# - security: impacts on the security of a product or a user’s deployment.
+# - upgrade: important information for someone upgrading from a prior version
+# - other: does not fit into any of the other categories
+kind: bug-fix
+
+# Change summary; a 80ish characters long description of the change.
+summary: "Remove : char from filename"
+
+# Long description; in case the summary is not enough to describe the change
+# this field accommodate a description without length limits.
+# NOTE: This field will be rendered only for breaking-change and known-issue kinds at the moment.
+description: "Double colon is a valid filename character on Linux but not on Windows or macOS. As such is preferred to always strip it from fragment filenames."
+
+# Affected component; a word indicating the component this changeset affects.
+component:
+
+# PR URL; optional; the PR number that added the changeset.
+# If not present is automatically filled by the tooling finding the PR where this changelog fragment has been added.
+# NOTE: the tooling supports backports, so it's able to fill the original PR number instead of the backport PR number.
+# Please provide it if you are adding a fragment for a different PR.
+#pr: https://github.com/owner/repo/1234
+
+# Issue URL; optional; the GitHub issue related to this changeset (either closes or is part of).
+# If not present is automatically filled by the tooling with the issue linked to the PR number.
+#issue: https://github.com/owner/repo/1234

internal/changelog/fragment/creator.go

@@ -83,5 +83,6 @@ func sanitizeFilename(s string) string {
 	s = strings.Replace(s, " ", "-", -1)
 	s = strings.Replace(s, "/", "-", -1)
 	s = strings.Replace(s, "\\", "-", -1)
+	s = strings.Replace(s, ":", "", -1)
 	return s
 }

internal/changelog/fragment/creator_internal_test.go

@@ -53,6 +53,7 @@ func TestSanitizeFilename(t *testing.T) {
 		{input: "foo/bar", want: "foo-bar"},
 		{input: "foo\\bar", want: "foo-bar"},
 		{input: "foo bar/foobar\\", want: "foo-bar-foobar-"},
+		{input: "foo bar: foobar", want: "foo-bar-foobar"},
 	}
 
 	for _, tc := range tests {