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

feat: add prebuild script for building sitemaps for builds #2664

Merged
merged 15 commits into from
Jan 15, 2025

Conversation

LeahMarieBush
Copy link
Contributor

@LeahMarieBush LeahMarieBush commented Jan 14, 2025

πŸ”— Relevant links

πŸ—’οΈ What

This PR adds a prebuild script that runs on the build step to determine if the docs and tutorials sitemaps are generated successfully. I also had to edit the allDocsFields and allTutorialsFields functions to take config as an argument since the script does not have access to the config when it is being run

🀷 Why

With the migration to UDR coming up over the next few months, this check makes sure the sitemaps are working properly to catch any errors we may have with the migration.

πŸ§ͺ Testing

  1. View the vercel build for the most recent commit and make sure it passes.
  2. View the vercel build for the simulate docs error commit and observe that it fails with an error stating that it had an issue building the docs paths
  3. View the vercel build for the simulate tutorials error commit and observe that it fails with an error stating that it had an issue building the tutorials paths

Copy link

vercel bot commented Jan 14, 2025

The latest updates on your projects. Learn more about Vercel for Git β†—οΈŽ

Name Status Preview Comments Updated (UTC)
dev-portal βœ… Ready (Inspect) Visit Preview πŸ’¬ Add feedback Jan 15, 2025 9:11pm

Copy link

github-actions bot commented Jan 14, 2025

πŸ“¦ Next.js Bundle Analysis

This analysis was generated by the next.js bundle analysis action πŸ€–

This PR introduced no changes to the javascript bundle πŸ™Œ

@LeahMarieBush LeahMarieBush marked this pull request as ready for review January 15, 2025 17:25
@LeahMarieBush LeahMarieBush requested review from a team, heatlikeheatwave and RubenSandwich and removed request for a team January 15, 2025 17:25
@LeahMarieBush LeahMarieBush changed the title feat: add github action for building sitemaps for PRs feat: add prebuild script for building sitemaps for builds Jan 15, 2025
@LeahMarieBush
Copy link
Contributor Author

Update: After some feedback in the Asana task, I changed this PR so that the build sitemap script is run on the prebuild step instead of having it run as a separate github action

Copy link
Collaborator

@RubenSandwich RubenSandwich left a comment

Choose a reason for hiding this comment

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

Looks great, thanks for this work! ❀️

@LeahMarieBush LeahMarieBush merged commit 04e090a into main Jan 15, 2025
9 checks passed
@LeahMarieBush LeahMarieBush deleted the leah/feat/build-fail-sitemap branch January 15, 2025 21:20
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.

2 participants