Skip to content

Artifacts cannot be uploaded with commas in their filename? #322

@gerph

Description

@gerph

Describe the bug

The documentation for the artifacts field states that the artifacts are a comma-separated list of files that should be uploaded as artifacts of the release. This means that filenames which contain a comma cannot be uploaded. Filenames with commas are expected for RISC OS releases, as they use the form <filename>,<filetype>. So for example, an HTML file (which has the filetype number 0xFAF) would be named index,faf. Such a file would be unable to be released.

To Reproduce

Reading the documentation. I've used some repositories that required the use of multiple artifacts and I was forced to use the comma form, which raised this as a problem I will encounter.

Expected behavior

Unclear how this can be addressed. Ideally, you would allow the artifacts value to be a list of filenames to upload, which would avoid the delimiting issue. However, I'm not sure whether that's actually allowed for actions - it's possible that action values must be simple.

Alternatively, space-separated filenames could be used instead of comma-separated. But that would obviously preclude filenames with spaces in. Or maybe a | separated list of filenames, as | is rarely used in filenames.

Given that the former option is probably not technically possible, and the latter option is fiddly and breaks compatibility, a possible solution might be to allow the separator to be specified explicitly. Having a artifactsSeparator key which defaults to , would retain the current format, but allow anyone who needs more control to allow commas in their artifact names by changing the separator to a character or sequence which isn't used.

Screenshots
N/A

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
None.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions