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

Generate sitemap on site deployment. #2335

Merged
merged 8 commits into from
Jul 2, 2021
Merged

Conversation

etefera
Copy link
Contributor

@etefera etefera commented Jun 25, 2021

Fixes #2273 by providing a sitemap.xml to be indexed by search console tools once it's hosted on kpt.dev
Fixes #1662 by relatedly prioritizing kpt.dev results over the old documentation site (already blocked on search)
Fixes #2229 by removing branch specificity on all workflows that check the validity of content (docs, licenses, site) to be picked up on branches of main. Workflows that test kpt directly also have no branch specificity to ensure legacy branches of main don't experience regressions but also ignore changes to docs or site content.

Copy link
Contributor

@droot droot left a comment

Choose a reason for hiding this comment

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

Some questions.

scripts/generate-sitemap.sh Outdated Show resolved Hide resolved
site/package.json Show resolved Hide resolved
scripts/generate-sitemap.sh Show resolved Hide resolved
.github/workflows/checkDocSync.yml Show resolved Hide resolved
@frankfarzan
Copy link
Contributor

frankfarzan commented Jun 25, 2021

Fixes #2273
Fixes #2229
Fixes #1662

How does this fix these issues? What's the PR is doing (add to PR description)?

@@ -15,13 +15,7 @@
name: Check Licenses
on:
Copy link
Contributor

Choose a reason for hiding this comment

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

do you want just "on: [push, pull_request]"?

How about other workflows? #2229

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed to just pull_request for all workflows bar releasing the tool or deploying the site. None of the workflows that check for a pristine state modify the state of the repo after merging a PR, so this should be sufficient until that's no longer the case.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think you want workflows to run on push. This visually ends up as a green check mark on the branch.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added for the sake of validation.

.github/workflows/checkDocSync.yml Show resolved Hide resolved
site/package.json Show resolved Hide resolved
@etefera etefera merged commit f82c930 into kptdev:main Jul 2, 2021
@etefera etefera deleted the generate-sitemap branch July 2, 2021 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants