docs(headless): updates the Headless typedoc uploading logic #4876
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
JIRA: https://coveord.atlassian.net/browse/KIT-3424
This PR changes the logic of how the Typedoc site is uploaded as an artifact. This is to streamline the process of publishing the generated docs at docs.coveo.com (the project that I'm working on these days).
I tested this approach in a local fork of this repo, you can look at the latest run that uses the same logic as suggested in this PR: https://github.com/npushkarskii/ui-kit/actions/runs/12832730326
Note
archiving in the workflow wasn't required as it resulted in creating an archive inside an archive. GH automatically creates an archive when we upload anything as an artifact.
the archive's names stays
headless-docs-{VERSION}.zip
(didn't change)The structure of the resulting archive will now be in the format:
The folder in the archive bears the name of the version.
Inside the version folder, there are the generated files