Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(headless): updates the Headless typedoc uploading logic #4876

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

npushkarskii
Copy link
Contributor

@npushkarskii npushkarskii commented Jan 17, 2025

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:

  1. The folder in the archive bears the name of the version.

  2. Inside the version folder, there are the generated files

image

@npushkarskii npushkarskii marked this pull request as ready for review January 17, 2025 21:15
@npushkarskii npushkarskii requested a review from a team as a code owner January 17, 2025 21:15
@npushkarskii npushkarskii requested review from olamothe, fpbrault, y-lakhdar and alexprudhomme and removed request for olamothe, fpbrault and y-lakhdar January 17, 2025 21:15
Copy link

Pull Request Report

PR Title

✅ Title follows the conventional commit spec.

Live demo links

Bundle Size

File Old (kb) New (kb) Change (%)
case-assist 243.8 243.8 0
commerce 355 355 0
search 414.9 414.9 0
insight 406.2 406.2 0
recommendation 256.1 256.1 0
ssr 408.8 408.8 0
ssr-commerce 372.7 372.7 0

SSR Progress

Use case SSR (#) CSR (#) Progress (%)
search 39 44 89
recommendation 0 4 0
case-assist 0 6 0
insight 0 27 0
commerce 0 15 0
Detailed logs search : buildInteractiveResult
search : buildInteractiveInstantResult
search : buildInteractiveRecentResult
search : buildInteractiveCitation
search : buildGeneratedAnswer
recommendation : missing SSR support
case-assist : missing SSR support
insight : missing SSR support
commerce : missing SSR support

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