Skip to content

Move sitemap from post-render action into GitHub workflow step #756

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

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

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jun 16, 2025

Internal Notes for Reviewers

This PR improves how sitemaps are generated.

Before After
Sitemaps are generated via a post-render action in _quarto.yml.

Every time you make a change while previewing the site locally, generating the sitemaps adds a delay of several seconds.
Sitemaps are generated as part of GitHub workflows for PR preview, staging, or prod deployment.

Sitemaps are no longer generated automatically but you can still use make generate-sitemap if you need to develop them further.

Proof the PR works

We're still getting the sitemaps, despite no longer having the post-render action:

External Release Notes

N/A

@nrichers nrichers added infrastructure Docs infra changes internal Not to be externalized in the release notes labels Jun 16, 2025
@nrichers nrichers requested a review from LoiAnsah June 16, 2025 18:54
Copy link
Contributor

PR Summary

This pull request introduces a change to the GitHub Actions workflows responsible for deploying and validating documentation. Specifically, it adds a step to generate a sitemap using the make generate-sitemap command in the deploy-docs-prod.yaml, deploy-docs-staging.yaml, and validate-docs-site.yaml workflows. This ensures that a sitemap is generated as part of the documentation deployment and validation processes. Additionally, the post-render step for generating the sitemap has been removed from the _quarto.yml configuration file, indicating a shift to handling sitemap generation within the CI/CD pipeline rather than as a post-render step in the project configuration.

Test Suggestions

  • Verify that the sitemap is correctly generated in the production deployment workflow.
  • Check that the sitemap is generated in the staging deployment workflow.
  • Ensure that the sitemap generation step does not cause any errors in the validate-docs-site workflow.
  • Test the overall documentation deployment process to confirm that the addition of the sitemap generation does not introduce any regressions.
  • Validate that the removal of the post-render step in _quarto.yml does not affect other parts of the documentation build process.

Copy link
Contributor

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

Copy link
Contributor

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.78 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: f62d8b3

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.75 0.51 1.00 0.89
/get-started/get-started.html 0.76 0.85 1.00 0.80
/guide/guides.html 0.76 0.86 1.00 0.90
/index.html 0.79 0.84 1.00 0.80
/releases/all-releases.html 0.85 0.88 1.00 0.80
/support/support.html 0.82 0.86 1.00 0.90
/training/training.html 0.73 0.71 0.96 0.80

@nrichers nrichers changed the title Move sitemap from post-render action into GitHub wworkflow step Move sitemap from post-render action into GitHub workflow step Jun 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Docs infra changes internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant