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

chore(CI): get docs building on ALL branches. #26854

Merged
merged 3 commits into from
Jan 29, 2024
Merged

chore(CI): get docs building on ALL branches. #26854

merged 3 commits into from
Jan 29, 2024

Conversation

rusackas
Copy link
Member

SUMMARY

This PR does a few things:

  • Splits the github action for docs in half
    • One now only runs on pushes to master... it builds and deploys docs after checking for secrets
    • One now only runs on PRs, and doesn't need secrets. It does typechecking (new step) and builds docs, and should run even on forks (e.g. dependabot bumps)
  • Fixes a couple of typescript checks that were noticed by the typechecking script.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

with:
persist-credentials: false
submodules: recursive
- name: yarn install
Copy link
Member

Choose a reason for hiding this comment

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

for these yarn commands, shouldn't there be a cd docs before?

Copy link
Member Author

Choose a reason for hiding this comment

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

I believe the working-directory parameter does that.

@@ -1,15 +1,11 @@
name: Docs
name: Docs Deployment
Copy link
Member

Choose a reason for hiding this comment

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

I think the filenames are reversed from what they should be

Copy link
Member Author

Choose a reason for hiding this comment

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

Oops! Names were right in the file, but the filenames themselves were wrong. Nice catch!

@rusackas rusackas merged commit 8db5d13 into master Jan 29, 2024
27 checks passed
@john-bodley john-bodley deleted the fix-docs-CI branch January 30, 2024 17:55
eschutho pushed a commit to preset-io/superset that referenced this pull request Jan 31, 2024
sfirke pushed a commit to sfirke/superset that referenced this pull request Mar 22, 2024
@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 4.0.0 labels Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/M 🚢 4.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants