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

Add workflow to build a deploy artifact and deploy to GH pages #5263

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

Conversation

amcaplan
Copy link
Contributor

WHY are these changes introduced?

Making the Version Packages PR just about versioning packages, instead of being 99.99% static docsite updates every time.

WHAT is this pull request doing?

Sets up a GitHub action that should generate and push our API docs to GitHub pages

How to test your changes?

We'll have to merge and see!

Measuring impact

How do we know this change was effective? Please choose one:

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

@amcaplan amcaplan requested a review from a team as a code owner January 23, 2025 18:42
Copy link
Contributor

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
75.33% (+0.01% 🔼)
8892/11804
🟡 Branches
70.57% (+0.03% 🔼)
4324/6127
🟡 Functions 75.1% 2337/3112
🟡 Lines
75.87% (+0.02% 🔼)
8404/11077
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / app-event-watcher.ts
93.83% (-1.23% 🔻)
86.49% 90.48% 98.61%

Test suite run success

2001 tests passing in 904 suites.

Report generated by 🧪jest coverage report action from b7083d2

@isaacroldan
Copy link
Contributor

Just to confirm, this job will only be executed when a PR is merged right? never on an open PR or non-main branch?
(because if it does, anyone could publish anything to our pages 😅 )

@gonzaloriestra
Copy link
Contributor

@isaacroldan yes, it will only happen when merging to main.

But I'm not getting this:

  • You are uploading docs to GH pages, but where exactly and why? Were we doing that?
  • If we don't merge the generated docs or create a PR, they will keep appearing in the Version Packages PR, no?

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