Skip to content

fix(ci): upload the DocC archive as a tarball - #13

Merged
euskadi31 merged 1 commit into
mainfrom
fix/docc-archive-upload
Aug 25, 2026
Merged

fix(ci): upload the DocC archive as a tarball#13
euskadi31 merged 1 commit into
mainfrom
fix/docc-archive-upload

Conversation

@euskadi31

Copy link
Copy Markdown
Contributor

The release of 0.1.0 went red on the documentation job:

With the provided path, there will be 386 files uploaded
Artifact name is valid!
Root directory input is valid!
##[error]The path for one of the files in artifact is not valid
Invalid characters include: Double quote ", Colon :, …

DocC names its files after the symbols they document, so validate(_:) becomes a
path containing a colon. upload-artifact refuses a colon because the artifact
has to unpack on Windows too. One character in a file name, and the whole release
reads as failed — while Everything must be green before a tag means anything,
the job that decides whether the tag means anything, had passed.

The archive is now packed with tar before upload.

Also: if-no-files-found was warn. A documentation job that produced
nothing at all would have uploaded nothing and reported success — so the job
could only ever fail for the reason it just did. It is now error.

The release of 0.1.0 went red on the documentation job. DocC names its files
after the symbols they document, so `validate(_:)` becomes a path containing a
colon, and upload-artifact refuses a colon because the artifact has to unpack on
Windows too. 386 files, one character, the whole release red -- while the job
that decides whether the tag means anything had passed.

The archive is now packed with tar before it is uploaded.

Also changed if-no-files-found from warn to error. It was set to warn, so a
documentation job that produced nothing at all would have uploaded nothing and
reported success. The job would then only ever fail for the reason it just did.
@euskadi31
euskadi31 merged commit 4261aa8 into main Aug 25, 2026
3 checks passed
@euskadi31
euskadi31 deleted the fix/docc-archive-upload branch August 25, 2026 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant