docs(headless): updates the Headless typedoc uploading logic #4876
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
npushkarskii
requested review from
olamothe,
fpbrault,
y-lakhdar and
alexprudhomme
and removed request for
olamothe,
fpbrault and
y-lakhdar
Pull Request ReportPR Title✅ Title follows the conventional commit spec. Live demo linksBundle Size
SSR Progress
Detailed logssearch : buildInteractiveResultsearch : buildInteractiveInstantResult search : buildInteractiveRecentResult search : buildInteractiveCitation search : buildGeneratedAnswer recommendation : missing SSR support case-assist : missing SSR support insight : missing SSR support commerce : missing SSR support |
npushkarskii
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
alexprudhomme
requested changes
Jan 20, 2025
Co-authored-by: Alex Prudhomme <78121423+alexprudhomme@users.noreply.github.com>
Co-authored-by: Alex Prudhomme <78121423+alexprudhomme@users.noreply.github.com>
npushkarskii
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
alexprudhomme
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
npushkarskii
temporarily deployed
to
PR Artifacts
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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