Skip to content

[BUILD] add mkdocs and doc portal PR previews - #124

Open
thomasbaronnet wants to merge 5 commits into
pasqal-io:mainfrom
thomasbaronnet:tb/2628-doc-portal-pr-preview
Open

thomasbaronnet wants to merge 5 commits into
pasqal-io:mainfrom
thomasbaronnet:tb/2628-doc-portal-pr-preview

Conversation

@thomasbaronnet

Copy link
Copy Markdown

Build and publish a mkdocs pr-preview plus a doc-portal preview on pull requests, and clean them up when the PR closes.

Build and publish a mkdocs pr-preview plus a doc-portal preview on pull requests, and clean them up when the PR closes.
@codecov-commenter

codecov-commenter commented Sep 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 38.27%. Comparing base (79c5d81) to head (73abae5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #124   +/-   ##
=======================================
  Coverage   38.27%   38.27%           
=======================================
  Files          17       17           
  Lines        1207     1207           
  Branches      140      140           
=======================================
  Hits          462      462           
  Misses        715      715           
  Partials       30       30           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

--entrypoint sh \
"$DOC_PORTAL_IMAGE" \
-c 'sh /app/docker/doc-portal-rebuild-source.sh qek && cp -r /app/packages/doc-portal/dist/. /out/'
-c 'cd /app && pnpm --filter @pasqal/doc-portal run build:selected && cp -r /app/packages/doc-portal/dist/. /out/'

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why this change?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well actually we need to rebuild all the doc portal so the links point inside the preview (like …/pr-N/qoolqit/). The other solution is to rebuild just qek but we'll have to run a script to change all the links after the build is done, and I think it's a bit "fragile". It won't take much long time and we'll have a better working platform. Let me know what you think

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.

3 participants